mdit-vue

markdown-it plugins for Vue.js

Why?

As we know, Markdown could be converted into HTML, and raw HTML is supported by most of the Markdown parsers.

Since the Vue template syntax is HTML-based, and all Vue templates are syntactically valid HTML, it's quite straight forward to think that we could use Vue template syntax in Markdown.

Unlike JSX, Vue template syntax is naturally compatible with Markdown syntax, so we don't have to make lots of extensions or limitations to Markdown syntax like MDX. However, we still need to make some modifications to the parser so that Markdown could have more fun with Vue.

There has been lots of projects that built with this idea, but they are using different ways to modify the Markdown parsers. Most of them don't strictly follow the Markdown specification and have various minor errors.

This project is here to provide some unified plugins for markdown-it, one of the most popular markdown parsers in JS world, to make it work better with Vue.

Packages

Package	Version (click for changelogs)
@mdit-vue/plugin-component
@mdit-vue/plugin-frontmatter
@mdit-vue/plugin-headers
@mdit-vue/plugin-sfc
@mdit-vue/plugin-title
@mdit-vue/plugin-toc

Who is using?

This project was originally extracted from Vue's official project, and maintained by Vue team members. It is supporting many awesome projects:

• Slidev
• unplugin-vue-markdown
• VitePress
• VuePress v2
• ... and so on

License

MIT © mdit-vue Contributors