使用docsify搭建多页面静态说明文档网站
2022-04-12 本文已影响0人
rainmanhhh
全局安装docsify
npm i -g docsify
初始化网站根目录(这里指定的目录为./docs
)
docsify init ./docs
设置参数多页面模式和相对路径
编辑上一步生成的./docs/index.html
, 设置以下参数
window.$docsify = {
name: 'docs test', // 文档标题,显示在根目录左侧菜单顶部. 如要修改浏览器页面标题,直接编辑index.html的title节点
repo: '', // git仓库地址,如果文档不附属于某个代码仓库,则留空
loadSidebar: true, // 使用_sidebar.md组装多页面网站
relativePath: true, // 使用相对路径链接
}
在每个目录创建_sidebar.md
文件
此文件用于生成每个目录的左侧跳转菜单,如不设置则会向上一级目录查找,直至根目录
例如,假设根目录下的_sidebar.md
内容为
* [sub](sub/)
* [sub2](sub2/)
则根目录的左侧菜单会显示两个链接,分别指向sub
和sub2
子目录(注意目录的链接都要以/
结尾)
为每个目录编写md文档
每个目录的README.md
在运行时作用相当于普通网站的index.html
,一个目录下也可放置多个md文档,此时_sidebar.md
中的链接就需要加上文件名(不带.md
后缀)
例如,假设根目录下的_sidebar.md
内容为
* [sub](sub/)
* [foo](foo)
则两个链接分别跳转到sub
子目录和当前目录下的foo.md