docsify文档编写工具

cfn
2020-11-30
568

前言

书写本文是记录一下自己的使用过程
官方文档请查看 https://docsify.js.org/#/zh-cn/

安装

需要安装好node和npm

全局安装

npm i docsify-cli -g

在当前目录初始化

docsify init

微信截图_20201130143300.png

本地预览

docsify serve

微信截图_20201130144146.png

编写文档

微信截图_20201130152655.png

定制侧边栏

设置

loadSidebar: true

创建文件 _sidebar.md

微信截图_20201130152918.png

配置搜索

引用js

https://cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js

search: { paths: 'auto', placeholder: '请输入要搜索的关键字', noData: '没有结果', depth: 7 }

配置上一页下一页

https://cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js

显示页面字数

https://unpkg.com/docsify-count/dist/countable.js

count:{ countable:true, fontsize:'0.9em', color:'rgb(90,90,90)', language:'chinese' }

复制代码

https://cdn.jsdelivr.net/npm/docsify-copy-code

copyCode: { buttonText : '点击复制', errorText : '错误', successText: '完成' }

图片缩放

https://cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js

评论 1