跳到主要内容

为Markdown功能添加GFM支持

本文介绍如何通过remark-gfm插件实现。Docusaurus自带的Markdown功能没有覆盖GFM的全部功能。如Tasklist功能、删除线等。

插件地址:https://github.com/remarkjs/remark-gfm

安装 remark-gfm

npm install remark-gfm
npm

配置

docusaurus.config.ts
import remarkGfm from 'remark-gfm';

export default {
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
path: 'docs',
remarkPlugins: [remarkGfm],
},
},
],
],
};
ts

使用举例

### Tasklist

* [ ] to do
* [x] done

### Strikethrough

~one~ or ~~two~~ tildes.
markdown

Tasklist

  • to do
  • done

Strikethrough

one or two tildes.