软件名称:Docsify
操作系统支持:全平台通用(Windows/macOS/Linux),浏览器直接运行,甚至可在手机端编辑Markdown。
软件介绍: “文档界的‘懒人神器’”——只需把Markdown文件扔进文件夹,Docsify就能自动变成带目录、搜索、代码高亮的网站!无需安装Node.js或折腾构建命令,改完保存就生效,连奶奶都能用!
Docsify:你的文档就是个“自动翻译器”
核心功能:
- 零配置动态渲染:写Markdown就像写微信聊天,保存即刷新页面。
- 插件全家桶:代码高亮、实时搜索、评论系统一键接入(比Notion还方便!)。
- 手机端友好:自动适配小屏幕,学生用iPad也能流畅浏览教学文档。
实用场景
- 团队协作场景
- 痛点:“我们5个人维护同一个技术手册,每次修改都要重新部署服务器,版本混乱到怀疑人生……”
- 爽点:用Docsify+Git托管Markdown文件,配合cpolar外链,所有成员实时看到最新版文档,再也不怕“你改的哪一稿?”。
- 个人知识库场景
- 痛点:“想把Python学习笔记整理成网站,但不会HTML/CSS,建个GitHub Pages都要抄代码?”
- 爽点:三步搞定:写Markdown→用Docsify打开文件夹→通过cpolar生成外网URL。朋友扫码就能看你的“个人图书馆”!
- 教学场景
- 痛点:“学校机房电脑不能联网,想让学生在线看编程教程?”
- 爽点:把课程资料存到内网电脑,用Docsify启动本地服务器,再通过cpolar穿透生成外网地址。学生在局域网内扫码即可访问动态文档!
cpolar内网穿透技术带来的便利
- 远程协作无压力:团队成员出差时也能实时查看更新的API文档,无需上传到云端服务器(省时又安全)。
- 教学场景再升级:老师在办公室编写课程资料,学生即使在家也能通过外链访问动态网页版教程。
- 零运维成本:不用申请域名或配置Nginx反向代理,cpolar自动分配子域链接,直接分享即可!
总结: Docsify是“懒人文档大师”,而cpolar让它从局域网“飞出”到全世界。两者结合后,无论是技术团队、教育工作者还是个人博主,都能用最简单的方式搭建可实时更新、支持搜索和代码高亮的专业级文档网站。简单、简易、简洁!
好的软件当然不能光说不练,教程已经准备如下👇有需要的小伙伴快去安装起来吧!
接下来,讲解如何在本地部署Docsify。
1. 本地部署Docsify
本篇文章安装环境:Windows10
Docsify 项目github地址:GitHub - docsifyjs/docsify: 🃏 A magical documentation site generator.
Docsify官方文档教程:docsify.js.org/#/zh-cn/
准备工具: node.js、Typora、cpolar内网穿透
Node.js (官网):nodejs.org/zh-cn
Typora(官网):typoraio.cn
首先查看node.js是否已安装
node -v
查看npm是否已安装
npm -v
如未安装,进入到node.js官网下载安装
安装完后,接下来需要安装Docsify本地全局工具
npm i docsify-cli -g
初始化Docsify本地项目
docsify init ./docs
启用本地网页预览
docsify serve docs
2. 使用Docsify搭建个人博客
打开 此电脑——C盘——用户——文档——docs文件夹
初始化成功后,可以看到 ./docs 目录下创建的几个文件
index.html入口文件README.md会做为主页内容渲染.nojekyll用于阻止 GitHub Pages 忽略掉下划线开头的文件
直接编辑 docs/README.md 就能更新文档内容,当然也可以[添加更多页面。
打开 README文档,做为主页内容渲染
在这个文档中进行修改,设计自己的个人博客,修改标题,添加文章内容,并保存
制作一个个人文档,我们只需要配置以下这几个基本文件就可以:
| 文件作用 | 文件 |
|---|---|
| 基础配置项(入口文件) | index.html |
| 封面配置文件 | _coverpage.md |
| 侧边栏配置文件 | _sidebar.md |
| 导航栏配置文件 | _navbar.md |
| 主页内容渲染文件 | README.md |
| 浏览器图标 | favicon.ico |
还有很多配置项可以参考docsify文档中的定制化-配置项—小节,定制的东西越多,维护的难度就越大。侧边栏、导航栏和封面都建议采用默认的文件渲染:
这里举例官网的封面配置文件
-
封面配置文件(_coverpage.md)
封面的生成同样是从 markdown 文件渲染来的。开启渲染封面功能后在文档根目录创建 _coverpage.md 文件。渲染效果如本文档。
index.html
<!-- index.html -->
<script>
window.$docsify = {
coverpage: true
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
<!-- _coverpage.md -->

# docsify <small>3.5</small>
> 一个神奇的文档网站生成器。
- 简单、轻便 (压缩后 ~21kB)
- 无需生成 html 文件
- 众多主题
[开始使用 Let Go](/README.md)
继续回到我们刚才搭建的页面,打开一个新的浏览器,输入localhost:3000,或者本机IP地址:3000
这样我们就在本地搭建了一个简单的个人文档博客,博客排版风格也可以自己随意设计,但是目前我们已经在本地搭建好了博客网站,如果没有公网IP的话,只能在本地局域网环境使用,有一定的局限性。如果出门在外想远程访问使用的话,可以结合cpolar内网穿透生成公网地址,免去了本地重新部署过程,只需要使用公网地址直接进就可以访问本地部署的Docsify,随时管理网站。
3. 安装Cpolar内网穿透工具
下面是安装cpolar步骤:
Cpolar官网地址: www.cpolar.com
点击进入cpolar官网,点击免费使用注册一个账号,并下载最新版本的Cpolar
登录成功后,点击下载Cpolar到本地并安装(一路默认安装即可)本教程选择下载Windows版本。
Cpolar安装成功后,在浏览器上访问http://localhost:9200,使用cpolar账号登录,登录后即可看到Cpolar web 配置界面,结下来在web 管理界面配置即可。
4. 配置公网地址
接下来配置一下本地 Docsify 的公网地址,
登录后,点击左侧仪表盘的隧道管理——创建隧道,
创建一个 个人博客网站 的公网http地址隧道:
- 隧道名称:可自定义命名,注意不要与已有的隧道名称重复
- 协议:选择 http
- 本地地址:3000
- 域名类型:免费选择随机域名
- 地区:选择China VIP
点击创建
隧道创建成功后,点击左侧的状态——在线隧道列表,查看所生成的公网访问地址,有两种访问方式,分别是http和https。
使用任意一个上面Cpolar生成的公网地址,在电脑或任意设备在浏览器进行登录访问,即可成功看到 本地博客网站 界面,这样一个可以远程访问的公网地址就创建好了,使用了Cpolar的公网域名,无需自己购买云服务器,即可在公网访问本地部署的服务了!
5. 配置固定公网地址
我们接下来为其配置固定的HTTP端口地址,该地址不会变化,方便分享给别人长期查看你的本地服务,而无需每天重复修改服务器地址。
配置固定http端口地址需要将cpolar升级到专业版套餐或以上。
登录cpolar官网,点击左侧的预留,选择保留二级子域名,设置一个二级子域名名称,点击保留,保留成功后复制保留的二级子域名名称。本教程中我创建的是二级子域名是 myhugo1,大家可以自定义创建。
返回登录Cpolar web UI管理界面,点击左侧仪表盘的隧道管理——隧道列表,找到所要配置的隧道 myblog ,点击右侧的编辑:
修改隧道信息,将保留成功的二级子域名配置到隧道中
- 域名类型:选择二级子域名
- Sub Domain:填写保留成功的二级子域名
点击更新(注意,点击一次更新即可,不需要重复提交)
更新完成后,打开在线隧道列表,此时可以看到公网地址已经发生变化,地址名称也变成了固定的二级子域名名称的域名:
最后,我们使用固定的公网地址在任何浏览器打开访问,可以看到成功访问使用Docsify搭建好的本地博客网站,这样一个固定且永久不变的二级子域名公网地址就设置好了。
以上就是如何在Windows系统电脑本地使用Docsify搭建一个博客网站,并结合cpolar内网穿透工具实现一键发布公网随时随地远程访问的全部流程。感谢您的观看,有任何问题欢迎留言交流。
结尾: 这种组合的价值在于将动态渲染技术与可靠穿透方案结合,在保证实时性的同时消除网络限制。当轻量级架构遇上灵活的公网暴露能力时,Docsify不仅成为GitBook替代选择,更可能重新定义快速文档建设的技术实现路径。