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

chore: update helpers

Browse source
This commit is contained in:
qingwei.li 2018-02-11 20:50:48 +08:00 • committed by cinwell.li
commit 371fbecfc2
3 changed files with 52 additions and 62 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/de-de/helpers.md
View file

@ -19,12 +19,12 @@ wird wie folgt gerendert:
Generelle Tipps wie: Generelle Tipps wie:
```markdown ```markdown
?> *TODO* unit test ?> _TODO_ unit test
``` ```
wird wie folgt gerendert: wird wie folgt gerendert:
?> *TODO* unit test ?> _TODO_ unit test
## Ignore to compile link ## Ignore to compile link
@ -34,18 +34,18 @@ Some time we will put some other relative path to the link, you have to need to
[link](/demo/) [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`. 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 Now you can do that
```md ```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. You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set title for link.
```md ```md
[link](/demo/ ":ignore title") [link](/demo/ ':ignore title')
<a href="/demo/" title="title">link</a> <a href="/demo/" title="title">link</a>
``` ```
@ -53,19 +53,17 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
## Set target attribute for link ## Set target attribute for link
```md ```md
[link](/demo ":target=_blank") [link](/demo ':target=_blank')
[link](/demo2 ":target=_self") [link](/demo2 ':target=_self')
``` ```
## Github Task Lists ## Github Task Lists
```md ```md
* [ ] foo * [ ] foo
* bar * bar
* [x] baz * [x] baz
* [] bam * [] bam <~ not working
* [ ] bim * [ ] bim
* [ ] lim * [ ] lim
``` ```
@ -73,6 +71,6 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
* [ ] foo * [ ] foo
* bar * bar
* [x] baz * [x] baz
* [] bam * [] bam <~ not working
* [ ] bim * [ ] bim
* [ ] lim * [ ] lim

22
docs/helpers.md
View file

@ -19,12 +19,12 @@ is rendered as:
General tips like: General tips like:
```markdown ```markdown
?> *TODO* unit test ?> _TODO_ unit test
``` ```
are rendered as: are rendered as:
?> *TODO* unit test ?> _TODO_ unit test
## Ignore to compile link ## Ignore to compile link
@ -34,18 +34,18 @@ Some time we will put some other relative path to the link, you have to need to
[link](/demo/) [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`. 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 Now you can do that
```md ```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. You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set title for link.
```md ```md
[link](/demo/ ":ignore title") [link](/demo/ ':ignore title')
<a href="/demo/" title="title">link</a> <a href="/demo/" title="title">link</a>
``` ```
@ -53,24 +53,23 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
## Set target attribute for link ## Set target attribute for link
```md ```md
[link](/demo ":target=_blank") [link](/demo ':target=_blank')
[link](/demo2 ":target=_self") [link](/demo2 ':target=_self')
``` ```
## Disable link ## Disable link
```md ```md
[link](/demo ":disabled") [link](/demo ':disabled')
``` ```
## Github Task Lists ## Github Task Lists
```md ```md
* [ ] foo * [ ] foo
* bar * bar
* [x] baz * [x] baz
* [] bam * [] bam <~ not working
* [ ] bim * [ ] bim
* [ ] lim * [ ] lim
``` ```
@ -78,7 +77,6 @@ You will get `<a href="/demo/">link</a>`html. Do not worry, you can still set ti
* [ ] foo * [ ] foo
* bar * bar
* [x] baz * [x] baz
* [ ] bam * [] bam <~ not working
* [ ] bim * [ ] bim
* [ ] lim * [ ] lim

24
docs/zh-cn/helpers.md
View file

@ -2,7 +2,6 @@
docsify 扩展了一些 Markdown 语法，可以让文档更易读。 docsify 扩展了一些 Markdown 语法，可以让文档更易读。
## 强调内容 ## 强调内容
适合显示重要的提示信息，语法为 `!> 内容`。 适合显示重要的提示信息，语法为 `!> 内容`。
@ -13,17 +12,15 @@ docsify 扩展了一些 Markdown 语法，可以让文档更易读。
!> 一段重要的内容，可以和其他 **Markdown** 语法混用。 !> 一段重要的内容，可以和其他 **Markdown** 语法混用。
## 普通提示 ## 普通提示
普通的提示信息，比如写 TODO 或者参考内容等。 普通的提示信息，比如写 TODO 或者参考内容等。
```markdown ```markdown
?> *TODO* 完善示例 ?> _TODO_ 完善示例
``` ```
?> *TODO* 完善示例 ?> _TODO_ 完善示例
## 忽略编译链接 ## 忽略编译链接
@ -33,39 +30,36 @@ docsify 扩展了一些 Markdown 语法，可以让文档更易读。
[link](/demo/) [link](/demo/)
``` ```
它将被编译为 `<a href="/#/demo/">link</a>` 并将加载 `/demo/README.md`. 可能你想跳转到 `/demo/index.html`。 它将被编译为 `<a href="/#/demo/">link</a>` 并将加载 `/demo/README.md`. 可能你想跳转到 `/demo/index.html`。
现在你可以做到这一点 现在你可以做到这一点
```md ```md
[link](/demo/ ":ignore") [link](/demo/ ':ignore')
``` ```
即将会得到 `<a href="/demo/">link</a>` html 代码。不要担心，你仍然可以为链接设置标题。 即将会得到 `<a href="/demo/">link</a>` html 代码。不要担心，你仍然可以为链接设置标题。
```md ```md
[link](/demo/ ":ignore title") [link](/demo/ ':ignore title')
<a href="/demo/" title="title">link</a> <a href="/demo/" title="title">link</a>
``` ```
## 设置链接的 target 属性 ## 设置链接的 target 属性
```md ```md
[link](/demo ":target=_blank") [link](/demo ':target=_blank')
[link](/demo2 ":target=_self") [link](/demo2 ':target=_self')
``` ```
## Github 任务列表 ## Github 任务列表
```md ```md
* [ ] foo * [ ] foo
* bar * bar
* [x] baz * [x] baz
* [] bam * [] bam <~ not working
* [ ] bim * [ ] bim
* [ ] lim * [ ] lim
``` ```
@ -73,6 +67,6 @@ docsify 扩展了一些 Markdown 语法，可以让文档更易读。
* [ ] foo * [ ] foo
* bar * bar
* [x] baz * [x] baz
* [] bam * [] bam <~ not working
* [ ] bim * [ ] bim
* [ ] lim * [ ] lim