markdown-ext

Add basic GFM support to VuePress with useful features.

Usage

npm i -D @vuepress/plugin-markdown-ext@next

import { markdownExtPlugin } from '@vuepress/plugin-markdown-ext'

export default {
  plugins: [
    markdownExtPlugin({
      // options
    }),
  ],
}

Syntax

Footnote

• Use [^Anchor text] in Markdown to define a footnote

• Use [^Anchor text]: ... to describe footnote content

• If there are multiple paragraphs in footnote, the paragraph show be double indented

Footnote 1 link[^first].

Footnote 2 link[^second].

Inline footnote^[Text of inline footnote] definition.

Duplicated footnote reference[^second].

[^first]: Footnote **can have markup**

    and multiple paragraphs.

[^second]: Footnote text.

Task list

• Use - [ ] some text to render an unchecked task item.
• Use - [x] some text to render a checked task item. (Capital X is also supported)

- [ ] Plan A
- [x] Plan B

Component

You can use component fence block to add a component into your markdown content. Both YAML and JSON format props data are supported:

• YAML Recommended:

  ```component ComponentName
  # component data here
  ```

• JSON:

  ```component ComponentName
  {
    // component data here
  }
  ```

```component Badge
text: Mr.Hope
type: tip
```

```component Badge
{
  "text": "Mr.Hope",
  "type": "tip"
}
```

v-pre

You can use any mustache syntax as raw text in v-pre container:

::: v-pre

{{ abc }}

:::

Options

gfm

• Type: boolean

• Details:

  Whether tweaks the behavior and features to be more similar to GitHub Flavored Markdown.

  markdown-it already supports tables and strike through by default. If this option is true, the following new features will be enabled:

  • Auto link (named linkify in markdown-it)
  • Hard breaks
  • Footnote
  • Task list

  Note: Not all behavior is exactly the same as GitHub Flavored Markdown.

footnote

• Type: boolean
• Default: false
• Enabled in GFM: Yes
• Details: Whether to enable footnote format support.

tasklist

• Type: MarkdownItTaskListOptions | boolean

  interface MarkdownItTaskListOptions {
    /**
     * Whether disable checkbox
     *
     * @default true
     */
    disabled?: boolean
  
    /**
     * Whether use `<label>` to wrap text
     *
     * @default true
     */
    label?: boolean
  }

• Default: false

• Enabled in GFM: Yes

• Details:

  Whether to enable tasklist format support. You can pass an object to config tasklist.

breaks

• Type: boolean
• Default: false
• Enabled in GFM: Yes
• Details: Whether convert \n in paragraphs into <br>s

linkify

• Type: boolean
• Default: false
• Enabled in GFM: Yes
• Details: Whether convert URL-like text into links

component

• Type: boolean
• Default: false
• Details: Whether to enable component fence support

vPre

• Type: boolean
• Default: false
• Details: Whether to enable v-pre wrapper.