mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-02 12:10:04 +08:00
2e00f4c993
* feat: ignore to compiled link, fixed #203 * feat: add noCompileLinks, fixed #203 * fix: remove test code
53 lines
915 B
Markdown
53 lines
915 B
Markdown
# Doc helper
|
|
|
|
docsify extends Markdown syntax to make your documents more readable.
|
|
|
|
## important content
|
|
|
|
Important content like:
|
|
|
|
```markdown
|
|
!> **Time** is money, my friend!
|
|
```
|
|
|
|
is rendered as:
|
|
|
|
!> **Time** is money, my friend!
|
|
|
|
## General tips
|
|
|
|
General tips like:
|
|
|
|
```markdown
|
|
?> *TODO* unit test
|
|
```
|
|
|
|
are rendered as:
|
|
|
|
?> *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>
|
|
```
|
|
|