docsify-docs-cn/docs/more-pages.md

125 lines
3.5 KiB
Markdown
Raw Normal View History

2018-07-01 07:27:01 -04:00
# 多页文档
如果需要创建多个页面,或者需要多级路由的网站,在 docsify 里也能很容易的实现。例如创建一个 `guide.md` 文件,那么对应的路由就是 `/#/guide`
假设你的目录结构如下:
```text
.
└── docs
├── README.md
├── guide.md
└── zh-cn
├── README.md
└── guide.md
2018-07-01 07:27:01 -04:00
```
那么对应的访问页面将是
```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
```
## 定制侧边栏
为了获得侧边栏您需要创建自己的_sidebar.md你也可以自定义加载的文件名。默认情况下侧边栏会通过 Markdown 文件自动生成,效果如当前的文档的侧边栏。
2018-07-01 07:27:01 -04:00
2021-06-08 21:40:59 -04:00
首先配置 `loadSidebar` 选项,具体配置规则见[配置项#loadSidebar](zh-cn/configuration#loadsidebar)。
2018-07-01 07:27:01 -04:00
```html
<!-- index.html -->
2018-07-01 07:27:01 -04:00
<script>
window.$docsify = {
loadSidebar: true
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
2018-07-01 07:27:01 -04:00
```
接着创建 `_sidebar.md` 文件,内容如下
```markdown
<!-- docs/_sidebar.md -->
2018-07-01 07:27:01 -04:00
* [首页](zh-cn/)
* [指南](zh-cn/guide)
```
需要在 `./docs` 目录创建 `.nojekyll` 命名的空文件,阻止 GitHub Pages 忽略命名是下划线开头的文件。
## 嵌套的侧边栏
你可能想要浏览到一个目录时,只显示这个目录自己的侧边栏,这可以通过在每个文件夹中添加一个 `_sidebar.md` 文件来实现。
2018-07-01 07:27:01 -04:00
`_sidebar.md` 的加载逻辑是从每层目录下获取文件,如果当前目录不存在该文件则回退到上一级目录。例如当前路径为 `/zh-cn/more-pages` 则从 `/zh-cn/_sidebar.md` 获取文件,如果不存在则从 `/_sidebar.md` 获取。
当然你也可以配置 `alias` 避免不必要的回退过程。
```html
<script>
window.$docsify = {
loadSidebar: true,
alias: {
'/.*/_sidebar.md': '/_sidebar.md'
}
}
</script>
```
!> 你可以在一个子目录中创建一个 `README.md` 文件来作为路由的默认网页。
## 用侧边栏中选定的条目名称作为页面标题
一个页面的 `title` 标签是由侧边栏中选中条目的名称所生成的。为了更好的 SEO ,你可以在文件名后面指定页面标题。
```markdown
<!-- docs/_sidebar.md -->
* [Home](/)
* [Guide](guide.md "The greatest guide in the world")
```
2018-07-01 07:27:01 -04:00
## 显示目录
2021-06-08 21:40:59 -04:00
自定义侧边栏同时也可以开启目录功能。设置 `subMaxLevel` 配置项,具体介绍见 [配置项#subMaxLevel](zh-cn/configuration#submaxlevel)。
2018-07-01 07:27:01 -04:00
```html
<!-- index.html -->
2018-07-01 07:27:01 -04:00
<script>
window.$docsify = {
loadSidebar: true,
subMaxLevel: 2
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
2018-07-01 07:27:01 -04:00
```
## 忽略副标题
2020-08-21 08:21:28 -04:00
当设置了 `subMaxLevel` 时,默认情况下每个标题都会自动添加到目录中。如果你想忽略特定的标题,可以给它添加 `<!-- {docsify-ignore} -->`
2018-07-01 07:27:01 -04:00
```markdown
# Getting Started
2020-08-21 08:21:28 -04:00
## Header <!-- {docsify-ignore} -->
2018-07-01 07:27:01 -04:00
该标题不会出现在侧边栏的目录中。
```
2020-08-21 08:21:28 -04:00
要忽略特定页面上的所有标题,你可以在页面的第一个标题上使用 `<!-- {docsify-ignore-all} -->`
2018-07-01 07:27:01 -04:00
```markdown
2020-08-21 08:21:28 -04:00
# Getting Started <!-- {docsify-ignore-all} -->
2018-07-01 07:27:01 -04:00
2020-08-21 08:21:28 -04:00
## Header
2018-07-01 07:27:01 -04:00
该标题不会出现在侧边栏的目录中。
```
2020-08-21 08:21:28 -04:00
在使用时, `<!-- {docsify-ignore} -->``<!-- {docsify-ignore-all} -->` 都不会在页面上呈现。