Docsify是一款动态生成文档网站的工具,可以快速帮助用户生成文档网站,而不会生成静态的.html文件,所有转换工作都是在运行时进行。与其他文档网站生成器不同,Docsify可以自动地将Markdown中的标题生成目录,并且可以配合码云或GitHub Pages快速搭建一个小型的文档网站。
Docsify的特点和用法:
– 无需构建,写完文档直接发布
– 容易使用并且轻量(压缩后 ~21kB)
– 智能的全文搜索
– 提供多套主题
– 丰富的API
– 支持Emoji
– 兼容IE11
– 支持服务端渲染SSR
用法:
安装:npm i docsify-cli -g
初始化:docsify init ./docs或docsify init wiki
本地预览:docsify serve docs或docsify serve wiki
部署到GitHub Pages:将docsify生成的文件上传到gh-pages分支
Docsify支持使用配置文件进行个性化设置,如设置导航栏、侧边栏、分页等。在Docsify的官方文档中,提供了详细的使用说明和示例代码。