概述
Docsify 是一款轻量级的 Markdown 文档网站生成工具,无需提前编译,写完内容保存后就能实时预览效果,适合程序员和技术博主搭建 API 文档、开发指南或个人博客。它支持 Emoji 表情、全文搜索和多浏览器兼容,用简单的 Markdown 文件就能构建结构清晰的网站。默认情况下 Docsify 只能在本地或局域网内访问,结合内网穿透工具可以解决局域网限制,实现公网访问。
1. 本地部署 Docsify
首先确保已安装 Node.js 环境。在终端中运行以下命令检查版本:
node -v
npm -v
如未安装,请前往 Node.js 官网下载安装。安装完成后,全局安装 Docsify 本地工具:
npm i docsify-cli -g
初始化 Docsify 本地项目:
docsify init ./docs
启用本地网页预览:
docsify serve docs
启动后在浏览器访问 localhost:3000 即可查看。
2. 配置文件说明
初始化成功后,./docs 目录下会创建几个关键文件:
index.html:入口文件README.md:主页内容渲染_coverpage.md:封面配置文件_sidebar.md:侧边栏配置文件_navbar.md:导航栏配置文件favicon.ico:浏览器图标
直接编辑 docs/README.md 即可更新文档内容。基础配置项可在 index.html 中设置,例如开启封面功能:
<!-- index.html -->
<script> window.$docsify ={ coverpage:true}</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
修改标题、添加文章内容并保存后,刷新页面即可看到变化。
3. 配置公网地址
若需在外网访问本地服务,可使用内网穿透工具生成公网地址。以通用内网穿透工具为例:
- 登录管理界面,进入隧道管理。
- 创建 HTTP 协议隧道,本地地址填写 3000。
- 选择随机域名类型,地区选择对应区域。
- 创建成功后,获取生成的公网访问地址(HTTP 或 HTTPS)。
- 在任意设备浏览器输入该地址,即可访问本地博客。
4. 配置固定公网地址
为方便长期分享,可配置固定的二级子域名:
- 在管理后台预留二级子域名名称。


