docs: add docsify-ignore

This commit is contained in:
qingwei.li
2017-03-16 08:48:21 +08:00
parent 28b3cb4249
commit bba957d3bc
4 changed files with 48 additions and 1 deletions

View File

@@ -68,3 +68,25 @@ Eine angepasste Seitenleist kann auch automatisch ein Inhaltsverzeichnis generie
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
```
## Ignoring Subheaders
When `subMaxLevel` is set, each header is automatically added to the table of contents by default. If you want to ignore a specific header, add `{docsify-ignore}` to it.
```markdown
# Getting Started
## Header {docsify-ignore}
This header won't appear in the sidebar table of contents.
```
To ignore all headers on a specific page, you can use `{docsify-ignore-all}` on the first header of the page.
```markdown
# Getting Started {docsify-ignore-all}
## Header
This header won't appear in the sidebar table of contents.
```
Both `{docsify-ignore}` and `{docsify-ignore-all}` will not be rendered on the page when used.