README.md

@comark/markdown-it

Comark (Component in Markdown) for markdown-it.

Use VS Code MDC Extension for IDE support.

Usage

npm i markdown-it @comark/markdown-it

import comark from '@comark/markdown-it'
import MarkdownIt from 'markdown-it'

const md = new MarkdownIt()
  .use(comark)

const result = md.render(`
# Hello

Hello **World** with :my-component{.text-red name="foo"}!
`)

Features

This plugin implements all the syntaxes documented in Comark Syntax. We are still testing behavior compatibility in detail before reaching v1.0.0.

• Block Component
  • Nesting
  • YAML Props
  • Slots
• Inline Components
• Inline Props
• Span
• Frontmatter. Frontmatter is not built-in in this plugin, we recommend using @mdit-vue/plugin-frontmatter if you want to use this plugin outside of Comark package,

License

Made with ❤️

Published under MIT License.

Credits

❤️ This project was originally created by Anthony Fu in 2022. Special thanks for the amazing work and inspiration! 🙏✨