sandros94 / nuxt-markdown-render Goto Github PK

Following the suggestion made in #3 there are a number of plugins that should be available by default, much like nuxt/content.

The first few that come to mind are:

• shiki
• markdown-it-mdc
• markdown-it-anchor
• markdown-it-github-alerts
• markdown-it-link-attributes
• markdown-it-table-of-contents

Feel free to suggest any and why.

I attempted to add the Shikiji code highlighting plugin, but encountered a failure as the content is not rendering on the page. Below is my usage method:

import Shikiji from 'markdown-it-shikiji'

export default defineNuxtConfig({
  modules: [
    // others
    'nuxt-markdown-render',
  ],

  nuxtMarkdownRender: {
    as: 'article',
    componentName: 'NotNuxtMarkdown',
    options: {
      html: true,
    },
    plugins: ['pluginMdc', Shikiji({
      themes: {
        light: 'vitesse-light',
        dark: 'vitesse-dark',
      },
    })],
    global: true,
  },

const md = '#hello world'
<NuxtMarkdown class="prose" :source="md" />

Could you please provide guidance on the correct usage or any additional steps needed to successfully add the Shikiji code highlighting plugin to my project? Thank you for your assistance!

I wonder if it is possible to look for some sort of registry and auto-install markdown-it plugins from npm.

Since #4 and the release of 1.7.0 there has been a performance regression. I guess it should have been expected.

This should be caused by me because I'm re-instancing markdown-it at each component/composable use

So, while testing out Nuxt Hub, I've noticed that this module alone boosts the size of at least 1.4MB, exceeding Cloudflare's free Worker's Plan.

I need to learn how to substitute the a tag with NuxtLinks so that TOC and other links would benefit from it.

Opened an issue at uc.micro and reporting the following error

Stackblitz repro

For now I'm going to override the uc.micro version to 2.0.0

In the main readme I do reference to antfu's markdown-it-mdc work, but I don't actually understand how to make it to work, although the plugin is correctly loaded and the tag rendered in html code.

It has been pointed to me that I should not use refs inside plugins, and indeed this breaks a number of functionalities I wanted to implement in the future. I'm considering to revert the plugin idea and go back to square one with only composable + component.

I guess I should start working on pre-releases instead of creating non-working majors

api docs

As a follow-up of #5, it would be nice to have an optional rule for NuxtImg.

Thanks for releasing this module!

I'm doing some research to find what works best in my case to parse markdown, and I'm curious about what are the differences between your own module and https://github.com/nuxt-modules/mdc

Thanks!