其他分享
首页 > 其他分享> > docsify文档说明

docsify文档说明

作者:互联网

docsify文档学习

前提配置

安装node js,并且通过命令npm i docsify-cli -g安装docsify-cli插件(其作用就是实现一个文件本地的初始化及本地效果预览) ,此后git上传并启用page省略

几个命令

docsify init ./ 初始化新建

docsify serve ./ 本地预览

开始文档

具体参照官网教程https://docsify.js.org/#/zh-cn/quickstart

这里是对我的配置模板进行说明

分为三部分

第一部分 相关配置文件

index.html入口文件 总配置

_navbar.md页首栏配置

_coverpage.md背景封面配置

_sidebar.md侧边栏具体配置

sw.js PWA离线缓存(断网也可以查看)的具体代码 注意本地查看在网页中去除 不然无法刷新

.nojekyll 避免在pages使用时会忽略调下划线以下内容

第二部分 style

存储需要引入的css,js插件及图片,即仓库

第三部分 markdown

存储相关的md文件(由于在侧边栏显示设置中从二级开始展示,所以我们写作的markdown从二级标题开始 因此一级标题可以作为注释内容)

注意 在侧边栏配置时注明了文件夹及文件夹名 侧边栏显示均会列出

在存储markdown文件的文件夹下新建README文件 实现的是说明文档的首页内容

日常使用

可以直接移植模板进行修改(index修改name,侧边栏添加路径,markdown中导入文件并且在README文件中修改首页说明的内容,coverpage修改标题 说明语句 开始阅读),使用前述插件docsify serve ./ 进行本地查看,使用git完成上传即可。

特别补充:

在这里的配置中实际上引入了中英文切换,这里不是自动翻译,而是准备了两种语言的文档,即建立两个markdown文件夹,由于侧边栏的语言显示需要在英文文件夹内同时再建立一个_sidebar进行优先级作用

还有一个功能,在md文件下填写以下内容可实现访问量统计

本站总访问量次

温馨说明

中国大陆访问比较慢的资源已打包替换为本地

标签:md,markdown,侧边,说明,文件夹,文档,docsify
来源: https://www.cnblogs.com/wqcstudy/p/14491355.html