Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mdit-vue/mdit-vue
markdown-it plugins for Vue.js
https://github.com/mdit-vue/mdit-vue
markdown markdown-it-plugin vue
Last synced: 7 days ago
JSON representation
markdown-it plugins for Vue.js
- Host: GitHub
- URL: https://github.com/mdit-vue/mdit-vue
- Owner: mdit-vue
- License: mit
- Created: 2022-06-16T02:34:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-28T03:10:30.000Z (about 2 months ago)
- Last Synced: 2024-11-02T02:03:02.537Z (11 days ago)
- Topics: markdown, markdown-it-plugin, vue
- Language: TypeScript
- Homepage:
- Size: 1.6 MB
- Stars: 180
- Watchers: 3
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
mdit-vue
> [markdown-it](https://github.com/markdown-it/markdown-it) plugins for [Vue.js](https://github.com/vuejs/core)
## Why?
As we know, [Markdown](https://www.markdownguide.org/getting-started/) could be converted into HTML, and raw HTML is supported by most of the Markdown parsers.
Since the [Vue template syntax](https://vuejs.org/guide/essentials/template-syntax.html) 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](https://en.wikipedia.org/wiki/Markdown).
Unlike [JSX](https://reactjs.org/docs/introducing-jsx.html), 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](https://mdxjs.com/). 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](https://commonmark.org/) and have various minor errors.
This project is here to provide some unified plugins for [markdown-it](https://github.com/markdown-it/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](packages/plugin-component) | [](packages/plugin-component/CHANGELOG.md) |
| [@mdit-vue/plugin-frontmatter](packages/plugin-frontmatter) | [](packages/plugin-frontmatter/CHANGELOG.md) |
| [@mdit-vue/plugin-headers](packages/plugin-headers) | [](packages/plugin-headers/CHANGELOG.md) |
| [@mdit-vue/plugin-sfc](packages/plugin-sfc) | [](packages/plugin-sfc/CHANGELOG.md) |
| [@mdit-vue/plugin-title](packages/plugin-title) | [](packages/plugin-title/CHANGELOG.md) |
| [@mdit-vue/plugin-toc](packages/plugin-toc) | [](packages/plugin-toc/CHANGELOG.md) |
## 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](https://github.com/slidevjs/slidev)
- [unplugin-vue-markdown](https://github.com/unplugin/unplugin-vue-markdown)
- [VitePress](https://github.com/vuejs/vitepress)
- [VuePress v2](https://github.com/vuepress/vuepress-next)
- ... and so on
## License
[MIT](https://github.com/mdit-vue/mdit-vue/blob/main/LICENSE) © [mdit-vue Contributors](https://github.com/mdit-vue/mdit-vue/graphs/contributors)