docsify/docs/helpers.md

1022 B

Doc helper

docsify extends Markdown syntax to make your documents more readable.

important content

Important content like:

!> **Time** is money, my friend!

is rendered as:

!> Time is money, my friend!

General tips

General tips like:

?> *TODO* unit test

are rendered as:

?> TODO unit test

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")