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

feat: custom sidebar, #4 (#5)

Browse source 
* feat: custom sidebar, #4

* fix dev html

* fix doc

* fix doc
This commit is contained in:
cinwell.li 2016-11-27 18:53:31 +08:00 • committed by GitHub
commit 37e7984e7e
6 changed files with 71 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/README.md
View file

@ -121,3 +121,26 @@ Root element.
<script src="//unpkg.com/docsify" data-el="#app"></script>
```
#### sidebar
Custom sidebar. if it'set, the TOC will be disabeld. Bind global variables on the `data-sidebar`.
![image](https://cloud.githubusercontent.com/assets/7565692/20647425/de5ab1c2-b4ce-11e6-863a-135868f2f9b4.png)
```html
<script>
window.sidebar = [
{ slug: '/', title: 'Home' },
{
slug: '/pageA',
title: 'page A',
children: [
{ slug: '/pageA/childrenB', title: 'children B' }
]
},
{ slug: '/PageC', title: 'Page C' }
]
</script>
<script src="/lib/docsify.js" data-sidebar="sidebar"></script>
```

22
docs/zh-cn.md
View file

@ -119,4 +119,26 @@ docsify serve docs
<script src="//unpkg.com/docsify" data-el="#app"></script>
```
#### sidebar
设置后 TOC 功能将不可用，适合导航较多的文档，`data-sidebar` 传入全局变量名。
![image](https://cloud.githubusercontent.com/assets/7565692/20647425/de5ab1c2-b4ce-11e6-863a-135868f2f9b4.png)
```html
<script>
window.sidebar = [
{ slug: '/', title: 'Home' },
{
slug: '/pageA',
title: 'page A',
children: [
{ slug: '/pageA/childrenB', title: 'children B' }
]
},
{ slug: '/PageC', title: 'Page C' }
]
</script>
<script src="/lib/docsify.js" data-sidebar="sidebar"></script>
```