jyapayne/docsify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(compiler): new helpers

Browse source
This commit is contained in:
cinwell.li 2019-03-31 16:01:22 +08:00
commit ffd7345fd2
6 changed files with 142 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

78
docs/helpers.md
View file

@ -7,24 +7,72 @@ docsify extends Markdown syntax to make your documents more readable.
Important content like:
```markdown
!> **Time** is money, my friend!
> [!] **Time** is money, my friend!
```
is rendered as:
!> **Time** is money, my friend!
> [!] **Time** is money, my friend!
## General tips
General tips like:
```markdown
?> _TODO_ unit test
> [?] _TODO_ unit test
```
are rendered as:
?> _TODO_ unit test
> [?] _TODO_ unit test
## More tips
```markdown
> [x] bad
> [v] good
```
> [x] bad
> [v] good
## Details
````markdown
> [details] Sample code
>
> js code
>
> ```javascript
> console.log("foo");
> ```
> [details:open] Sample code open
>
> js code
>
> ```javascript
> console.log("foo");
> ```
````
> [details] Sample code
>
> js code
>
> ```javascript
> console.log("foo");
> ```
> [details:open] Sample code open
>
> js code
>
> ```javascript
> console.log("foo");
> ```
## Ignore to compile link
@ -39,13 +87,13 @@ It will be compiled to `<a href="/#/demo/">link</a>` and will be loaded `/demo/R
Now you can do that
```md
[link](/demo/ ':ignore')
[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')
[link](/demo/ ":ignore title")
<a href="/demo/" title="title">link</a>
```
@ -53,14 +101,14 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
## Set target attribute for link
```md
[link](/demo ':target=_blank')
[link](/demo2 ':target=_self')
[link](/demo ":target=_blank")
[link](/demo2 ":target=_self")
```
## Disable link
```md
[link](/demo ':disabled')
[link](/demo ":disabled")
```
## Github Task Lists
@ -84,17 +132,17 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
## Image resizing
```md
![logo](https://docsify.js.org/_media/icon.svg ':size=50x100')
![logo](https://docsify.js.org/_media/icon.svg ':size=100')
![logo](https://docsify.js.org/_media/icon.svg ":size=50x100")
![logo](https://docsify.js.org/_media/icon.svg ":size=100")
<!-- Support percentage -->
![logo](https://docsify.js.org/_media/icon.svg ':size=10%')
![logo](https://docsify.js.org/_media/icon.svg ":size=10%")
```
![logo](https://docsify.js.org/_media/icon.svg ':size=50x100')
![logo](https://docsify.js.org/_media/icon.svg ':size=100')
![logo](https://docsify.js.org/_media/icon.svg ':size=10%')
![logo](https://docsify.js.org/_media/icon.svg ":size=50x100")
![logo](https://docsify.js.org/_media/icon.svg ":size=100")
![logo](https://docsify.js.org/_media/icon.svg ":size=10%")
## Customise ID for headings

2
docs/static.md
View file

@ -1,6 +1,6 @@
# Generate static html
_Experimental feature_
> _Experimental feature_
Generating static html files is good for SEO and speeds up the first rendering.