If you are upgrading an existing app, read the Upgrade Guide for QMarkdown v3.

Everything you need for a complete solution

QMarkdown allows you to write markdown via slotted content (or a src property). QMarkdown wraps the markdown-it package, which for the most part, follows the commonmark specifications. It also has a lot of plugins, or you can write your own, for extending QMarkdown.

Features

1. Blockquotes
2. Code blocks (with copy to clipboard and line numbers support)
3. Containers
4. Emphasis
5. Headings
6. Horizontal rules
7. Links (specific and magic links)
8. Lists
9. Tables
10. Titles
11. Typography

QMarkdown is also extensible via the plugins property.

Try out these fine plugins for additional functionality:

1. Abbreviations
2. Definition lists
3. Emojies
4. Footnotes
5. Insert
6. Mark
7. Subscript/Superscript
8. Task lists
9. Mermaid

Global Properties

For all properties that can be used with QMarkdown, you can set the global properties via the useQMarkdownGlobalProps function.

Here is an example using the markdown-it-mermaid plugin from a boot file:

import { useQMarkdownGlobalProps } from '@quasar/quasar-ui-qmarkdown'
import mermaid from '@datatraccorporation/markdown-it-mermaid'

// defaults for QMarkdown
useQMarkdownGlobalProps({
  plugins: [mermaid]
})

The markdown-it-mermaid plugin is now globally available wherever you use QMarkdown.