docsify/docs/helpers.md

28 lines
345 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