docsify/docs/helpers.md

60 lines
1022 B
Markdown
Raw Normal View History

2017-02-13 22:43:58 +08:00
# Doc helper
docsify extends Markdown syntax to make your documents more readable.
## important content
2017-03-10 05:19:07 +08:00
Important content like:
2017-02-13 22:43:58 +08:00
```markdown
!> **Time** is money, my friend!
```
2017-03-10 05:19:07 +08:00
is rendered as:
2017-02-13 22:43:58 +08:00
2017-03-10 05:19:07 +08:00
!> **Time** is money, my friend!
2017-02-13 22:43:58 +08:00
## General tips
2017-03-10 05:19:07 +08:00
General tips like:
2017-02-13 22:43:58 +08:00
```markdown
?> *TODO* unit test
```
2017-03-10 05:19:07 +08:00
are rendered as:
2017-02-13 22:43:58 +08:00
2017-03-10 05:19:07 +08:00
?> *TODO* unit test
## Ignore to compile link
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
```md
[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
```md
[link](/demo/ ":ignore")
```
You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set title for link.
```md
[link](/demo/ ":ignore title")
<a href="/demo/" title="title">link</a>
```
## Set target attribute for link
```md
[link](/demo ":target=_blank")
[link](/demo2 ":target=_self")
```