2017-02-12 15:51:26 +08:00
|
|
|
# 多页文档
|
|
|
|
|
2017-02-13 22:43:58 +08:00
|
|
|
如果需要创建多个页面,或者需要多级路由的网站,在 docsify 里也能很容易的实现。例如创建一个 `guide.md` 文件,那么对应的路由就是 `/#/guide`。
|
2017-02-12 15:51:26 +08:00
|
|
|
|
2017-02-13 22:43:58 +08:00
|
|
|
假设你的目录结构如下:
|
2017-02-12 15:51:26 +08:00
|
|
|
|
|
|
|
```text
|
|
|
|
-| docs/
|
|
|
|
-| README.md
|
|
|
|
-| guide.md
|
|
|
|
-| zh-cn/
|
|
|
|
-| README.md
|
|
|
|
-| guide.md
|
|
|
|
```
|
|
|
|
|
|
|
|
那么对应的访问页面将是
|
|
|
|
|
|
|
|
```text
|
|
|
|
docs/README.md => http://domain.com
|
|
|
|
docs/guide.md => http://domain.com/guide
|
|
|
|
docs/zh-cn/README.md => http://domain.com/zh-cn/
|
|
|
|
docs/zh-cn/guide.md => http://domain.com/zh-cn/guide
|
|
|
|
```
|
|
|
|
|
|
|
|
## 定制侧边栏
|
|
|
|
|
2017-02-12 20:12:36 +08:00
|
|
|
默认情况下,侧边栏会根据当前文档的标题生成目录。也可以设置文档链接,通过 Markdown 文件生成,效果如当前的文档的侧边栏。
|
2017-02-12 15:51:26 +08:00
|
|
|
|
2017-02-13 22:43:58 +08:00
|
|
|
首先配置 `loadSidebar` 选项,具体配置规则见[配置项#load-sidebar](zh-cn/configuration#load-sidebar)。
|
2017-02-12 15:51:26 +08:00
|
|
|
|
|
|
|
```html
|
|
|
|
<script>
|
|
|
|
window.$docsify = {
|
|
|
|
loadSidebar: true
|
|
|
|
}
|
|
|
|
</script>
|
|
|
|
<script src="//unpkg.com/docsify"></script>
|
|
|
|
```
|
|
|
|
|
|
|
|
接着创建 `_sidebar.md` 文件,内容如下
|
|
|
|
|
|
|
|
```markdown
|
|
|
|
- [首页](zh-cn/)
|
|
|
|
- [指南](zh-cn/guide)
|
|
|
|
```
|
|
|
|
|
2017-02-12 20:12:36 +08:00
|
|
|
!> 需要在文档根目录创建 `.nojekyll` 命名的空文件,阻止 GitHub Pages 忽略命名是下划线开头的文件。
|
2017-02-12 15:51:26 +08:00
|
|
|
|
|
|
|
|
2017-02-12 20:12:36 +08:00
|
|
|
`_sidebar.md` 的加载逻辑是从每层目录下获取文件,如果当前目录不存在该文件则回退到上一级目录。例如当前路径为 `/zh-cn/more-pages` 则从 `/zh-cn/_sidebar.md` 获取文件,如果不存在则从 `/_sidebar.md` 获取。
|
|
|
|
|
2017-02-12 15:51:26 +08:00
|
|
|
## 显示目录
|
|
|
|
|
|
|
|
自定义侧边栏同时也可以开启目录功能。设置 `subMaxLevel` 配置项,具体介绍见 [配置项#sub-max-level](zh-cn/configuration#sub-max-level)。
|
|
|
|
|
|
|
|
```html
|
|
|
|
<script>
|
|
|
|
window.$docsify = {
|
|
|
|
loadSidebar: true,
|
|
|
|
subMaxLevel: 2
|
|
|
|
}
|
|
|
|
</script>
|
|
|
|
<script src="//unpkg.com/docsify"></script>
|
|
|
|
```
|
2017-02-12 20:12:36 +08:00
|
|
|
|
|
|
|
|