Docsify 是什么?
简单说,它就是个 “帮你把 Markdown 文件直接变成网页文档” 的工具。你不用学复杂的代码,也不用搞什么打包、编译,写完 Markdown(就是那些带 # 标题、* 列表的文本文件),它直接就能在浏览器里显示成带目录、能搜索、能跳转的漂亮文档页。打个比方:如果 Markdown 是 “手稿”,docsify 就是个 “自动把手稿装订成带目录的精装书” 的机器,而且还不用等,写完一页就马上能看效果。
Docsify 可以做什么?
它的核心作用就是 “快速搭一个能在线看的文档网站”,具体能搞定这些事:
写技术文档:比如你开发了个工具,用它搭个 “使用说明书”,别人能在线看怎么安装、怎么用,还能搜关键词找内容。
做个人笔记库:你平时记的编程笔记、学习心得,用 Markdown 写好,丢给 docsify,就能变成一个自己的在线 “知识库”,随时打开浏览器看。
团队共享文档:小团队不用买复杂的文档系统,大家一起在 Git 里改 Markdown 文件,docsify 自动变成网页,谁都能访问,改完马上生效。
临时展示材料:比如你要给客户演示一个方案,不用费劲排版成 Word 或 PPT,用 Markdown 写好,docsify 一键变成网页,发个链接对方就能看,还能随时改内容。
Docsify 特性
没有静态生成的 html 文件
简单和轻量
智能的全文搜索
提供多套主题
丰富的 API
支持 Emoji
Docsify 怎么用?
用法一:使用Node.js
安装Node.js和npm
全局安装docsify-cli:
初始化项目:
生成index.html、README.md和.nojekyll文件。
基本目录结构
index.html:网站配置入口(如标题、侧边栏等)README.md:默认主页内容.nojekyll:防止GitHub Pages忽略下划线文件
功能配置
侧边栏:在
index.html中通过_sidebar.md定义导航路径多级文档:创建子目录并添加
README.md,通过URL路径访问(如/docs/java/README.md)插件扩展:支持全文搜索、主题切换等插件
用法二
直接CDN引入
初始化