docsify/docs/zh-cn/helpers.md
2017-11-09 13:06:23 +08:00

1.3 KiB

文档助手

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

强调内容

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

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

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

普通提示

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

?> *TODO* 完善示例

?> TODO 完善示例

Some time we will put some other relative path to the link, you have to need to tell docsify you don't need to compile this link. For example

[link](/demo/)

It will be compiled to <a href="/#/demo/">link</a> and will be loaded /demo/README.md. Maybe you want to jump to /demo/index.html.

Now you can do that

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

You will get <a href="/demo/">link</a>html. Do not worry, you can still set title for link.

[link](/demo/ ":ignore title")

<a href="/demo/" title="title">link</a>
[link](/demo ":target=_blank")
[link](/demo2 ":target=_self")

Github Task Lists


* [ ] foo
 * bar
 * [x] baz
 * [] bam
   * [ ] bim
   * [ ] lim
  • foo
  • bar
  • baz
  • [] bam
    • bim
    • lim