如果你需要更多页面,你可以简单地在 docsify 目录中创建更多 markdown 文件。 如果创建了名为 guide.md
的文件,则可通过 /#/guide
访问该文件。
例如,目录结构如下:
.
└── docs
├── README.md
├── guide.md
└── zh-cn
├── README.md
└── guide.md
匹配路由
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
(有关示例,请参阅本文档的侧边栏):
首先,你需要设置为 loadSidebar
为 true。 详情请参见配置段落。
<!-- index.html -->
<script>
window.$docsify = {
loadSidebar: true,
};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
创建 _sidebar.md
:
<!-- docs/_sidebar.md -->
- [Home](/)
- [Page 1](page-1.md)
创建章节标题:
<!-- docs/_sidebar.md -->
- Section Header 1
- [Home](/)
- [Page 1](page-1.md)
- Section Header 2
- [Page 2](page-2.md)
- [Page 3](page-3.md)
需要在 ./docs
目录创建 .nojekyll
命名的空文件,阻止 GitHub Pages 忽略命名是下划线开头的文件。
!> Docsify 只查找当前文件夹中的 _sidebar.md
,并使用它,否则会返回到使用 window.$docsify.loadSidebar
配置。
示例文件结构:
└── docs/
├── _sidebar.md
├── index.md
├── getting-started.md
└── running-services.md
你可能希望侧边栏在导航后更新以反映当前目录。 这可以通过在每个文件夹中添加一个 _sidebar.md
文件来实现。
_sidebar.md
会从每一级目录加载。 如果当前目录中没有 _sidebar.md
,则会返回上一级目录。 例如,如果当前路径是 /guide/quick-start
,则将从 /guide/_sidebar.md
加载 _sidebar.md
。
你可以指定 alias
以避免不必要的回退。
<script>
window.$docsify = {
loadSidebar: true,
alias: {
'/.*/_sidebar.md': '/_sidebar.md',
},
};
</script>
!> 你可以在一个子目录中创建一个 README.md
文件来作为路由的默认网页。
页面的 title
标签是根据_选定的_侧边栏项目名称生成的。 为了更好地进行搜索引擎优化,你可以在文件名后指定一个字符串来自定义标题。
<!-- docs/_sidebar.md -->
- [Home](/)
- [Guide](guide.md 'The greatest guide in the world')
创建 _sidebar.md
后,侧边栏内容将根据 markdown 文件中的标题自动生成。
自定义侧边栏还可以通过设置 subMaxLevel
自动生成目录,请比较 subMaxLevel 配置。
<!-- index.html -->
<script>
window.$docsify = {
loadSidebar: true,
subMaxLevel: 2,
};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script>
当设置了 subMaxLevel
时,默认情况下每个标题都会自动添加到目录中。 如果你想忽略特定的标题,可以给它添加 <!-- {docsify-ignore} -->
。
# Getting Started
## Header <!-- {docsify-ignore} -->
该标题不会出现在侧边栏目录中。
要忽略特定页面上的所有标题,你可以在页面的第一个标题上使用 <!-- {docsify-ignore-all} -->
。
# Getting Started <!-- {docsify-ignore-all} -->
## Header
该标题不会出现在侧边栏的目录中。
在使用时,<!-- {docsify-ignore} -->
和 <!-- {docsify-ignore-all} -->
都不会在页面上呈现。
{docsify-ignore}
和 {docsify-ignore-all}
也可以做同样的事情。