FAQ

①不支持 「任务列表」语法?

1565932396037

如何让它支持这样的语法?

1565936273131

0.x的语法

module.exports = { 
  markdown: {
    lineNumbers: true,
    // markdown-it-anchor 的选项
    anchor: { permalink: false },
    // markdown-it-toc 的选项
    toc: { includeLevel: [1, 2] },
    // 
    checkbox: {
      divWrap: true,
      divClass: 'cb',
      idPrefix: 'cbx_'
    },
    config: md => {
      // 使用更多的 markdown-it 插件!
      md.use(require('markdown-it-checkbox'))
    }
  },
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

1.x的语法

module.exports = {
  markdown: {
    // markdown-it-anchor 的选项
    anchor: { permalink: false },
    // markdown-it-toc 的选项
    toc: { includeLevel: [1, 2] },
    extendMarkdown: md => {
      // 使用更多的 markdown-it 插件!
      md.use(require('markdown-it-xxx'))
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12

我被x.0的语法坑了!我之前一直看的是 x.0的语法

关于checkbox的选项,可以参考anchor的选项是怎么来的,然后你就可以依葫芦画瓢的去写checkbox的选项了。

如markdown-it-checkbox给出的用法是这样的:

var md = require('markdown-it')()
            .use(require('markdown-it-checkbox'),{
              divWrap: true,
              divClass: 'cb',
              idPrefix: 'cbx_'
            });

md.render('[ ] unchecked') // =>
// <p>
//  <div classname="cb">
//    <input type="checkbox" id="cbx_0">
//    <label for="cbx_0">unchecked</label>
//  </div>
// </p>
1
2
3
4
5
6
7
8
9
10
11
12
13
14

那么你只需要关注这个选项 即可:

{
  divWrap: true,
  divClass: 'cb',
  idPrefix: 'cbx_'
}
1
2
3
4
5

至于渲染,vuepress遇到下边这样的语法:

[ ] unchecked
1

就会渲染成这样:

如果你不想让markdown-it-checkbox这个扩展去解析渲染 [ ] unchecked ,那么你就用代码块语法(``` ```),或者(\)转义,而不是直接 代码 语法( ` `)

➹:Markdown 拓展 | VuePress 1.x

➹:在 Vuepress 中使用 | markdown-it-vuese

➹:优质的 Markdown-It 插件 | 小昱个人网站 | 昱之家

➹:markdown-it/markdown-it: Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed

②vuepress插件开发?

➹:示例 | markdown-it-vuese

➹:demo-code

➹:使用 markdown-it 解析 markdown 代码(读 VuePress 三) - 掘金

③基于Vuepress的markdown书写规范?

①CheckBox

Input

不要在 [ ] checkbox 前边写上文字,不然这些文字将不会被渲染!
1

Output

1565948366183

Last Updated: 8/16/2019, 7:59:03 PM