Docsify 是一款轻量级文档网站生成工具,能直接将 Markdown 文件转换成带目录、搜索、代码高亮的在线文档,无需构建编译,修改后保存即生效。它适合技术团队维护 API 手册、教师整理课程资料、个人搭建学习笔记库,优点是零配置上手快、全平台兼容,手机和电脑都能流畅访问,且无需掌握专业前端知识。
使用时能感受到它的便捷性,但也有小细节需要注意:建议用清晰的文件夹结构管理 Markdown 文件,方便后续查找;默认侧边栏和封面足够日常使用,过度定制插件可能增加维护成本;如果文档包含大量图片,建议统一存储路径,避免链接失效。
不过 Docsify 默认仅支持局域网访问,限制了使用场景:团队成员异地办公时,无法实时查看最新的文档更新;个人想把学习笔记分享给外地朋友,只能通过文件传输,无法提供在线浏览体验;教师在机房搭建的编程教程,学生回家后就无法继续查阅复习。
而 Docsify 与 cpolar 结合后,这些问题都能轻松解决。cpolar 能为局域网内的 Docsify 文档生成公网访问地址,无需购买云服务器或配置域名,支持一键分享。借助这个公网链接,团队成员异地也能协同维护文档,个人笔记可直接分享给他人,教师的课程资料学生在家也能随时访问,大大拓展了文档的使用范围。
好的软件当然不能光说不练,教程已经准备如下👇有需要的小伙伴快去安装起来吧!
接下来,讲解如何在本地部署Docsify。
1. 本地部署Docsify
本篇文章安装环境:Windows10
Docsify 项目github地址:GitHub - docsifyjs/docsify: 🃏 A magical documentation site generator.
Docsify官方文档教程:https://docsify.js.org/#/zh-cn/
准备工具:node.js、Typora、cpolar内网穿透
Node.js (官网):https://nodejs.org/zh-cn
Typora(官网):https://typoraio.cn
首先查看node.js是否已安装
node-v查看npm是否已安装
npm-v如未安装,进入到node.js官网下载安装
安装完后,接下来需要安装Docsify本地全局工具
npmi docsify-cli -g初始化Docsify本地项目
docsify init ./docs启用本地网页预览
docsify serve docs2. 使用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><scriptsrc="//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官网地址: https://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 简化了专业文档站的搭建流程,cpolar 则让局域网内的文档突破网络限制。二者组合,为个人、团队和教育场景提供了高效、低成本的文档管理与分享方案,让文档的创建、更新和传播变得更加灵活便捷。
cpolar官网-安全的内网穿透工具 | 无需公网ip | 远程访问 | 搭建网站