文档助手

docsify 扩展了一些 Markdown 语法,可以让文档更易读。

强调内容

适合显示重要的提示信息,语法为 !> 内容

  1. !> 一段重要的内容,可以和其他 **Markdown** 语法混用。

!> 一段重要的内容,可以和其他 Markdown 语法混用。

普通提示

普通的提示信息,比如写 TODO 或者参考内容等。

  1. ?> *TODO* 完善示例

?> TODO 完善示例

忽略编译链接

有时候我们会把其他一些相对路径放到链接上,你必须告诉 docsify 你不需要编译这个链接。 例如:

  1. [link](/demo/)

它将被编译为 <a href="/#/demo/">link</a> 并将加载 /demo/README.md. 可能你想跳转到 /demo/index.html

现在你可以做到这一点

  1. [link](/demo/ ":ignore")

即将会得到 <a href="/demo/">link</a> html 代码。不要担心,你仍然可以为链接设置标题。

  1. [link](/demo/ ":ignore title")
  2. <a href="/demo/" title="title">link</a>

设置链接的 target 属性

  1. [link](/demo ":target=_blank")
  2. [link](/demo2 ":target=_self")

Github 任务列表

  1. * [ ] foo
  2. * bar
  3. * [x] baz
  4. * [] bam
  5. * [ ] bim
  6. * [ ] lim
  • foo
    • bar
    • baz
    • [] bam
      • bim
      • lim