核心内容摘要
RedPanda-CPP项目模板使用技巧：快速创建专业C/C++工程
Docsify 是一款轻量化的文档生成工具核心功能是将 Markdown 文件直接渲染成带目录、搜索、代码高亮的网页无需安装复杂环境也不用构建 HTML 文件修改内容保存后页面实时刷新适配 Windows、macOS、Linux 全平台手机端也能流畅浏览编辑适合技术团队、教师、知识博主这类需要快速整理和分享文档的人群优点是零配置、易上手能大幅降低文档网站的搭建成本。
使用 Docsify 的过程中发现它虽然操作简单但新手容易忽略基础文件的配置逻辑比如封面、侧边栏需要单独创建对应 MD 文件才能生效另外纯本地运行时若修改了文件存储路径需要重新启动预览服务这点对频繁调整文档结构的用户稍显麻烦。
接入 cpolar 解决了 Docsify 仅限局域网访问的问题后使用体验和应用场景都得到了拓展之前只能在自己的电脑上查看整理的文档现在哪怕在通勤路上用手机打开公网链接就能修改技术笔记团队协作时5 个人维护的技术手册不用再反复部署服务器修改后所有人都能实时看到最新版本不用再问 “你改的是哪一稿”甚至学校机房的教程文档学生在家也能通过链接访问不用局限在局域网内真正实现了文档的随时随地访问和协作。
好的软件当然不能光说不练教程已经准备如下有需要的小伙伴快去安装起来吧接下来讲解如何在本地部署Docsify。
本地部署Docsify本篇文章安装环境Windows10Docsify 项目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-cnTypora官网https://typoraio.cn首先查看node.js是否已安装node-v查看npm是否已安装npm-v如未安装进入到node.js官网下载安装安装完后接下来需要安装Docsify本地全局工具npmi docsify-cli -g初始化Docsify本地项目docsify init ./docs启用本地网页预览docsify serve docs
使用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 --scriptwindow.$docsify{coverpage:true}/scriptscriptsrc//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js/script!-- _coverpage.md -- # docsifysmall
5/small 一个神奇的文档网站生成器。
- 简单、轻便 (压缩后 ~21kB) - 无需生成 html 文件 - 众多主题 [开始使用 Let Go](/README.md)继续回到我们刚才搭建的页面打开一个新的浏览器输入localhost:3000或者本机IP地址:3000这样我们就在本地搭建了一个简单的个人文档博客博客排版风格也可以自己随意设计但是目前我们已经在本地搭建好了博客网站如果没有公网IP的话只能在本地局域网环境使用有一定的局限性。
如果出门在外想远程访问使用的话可以结合cpolar内网穿透生成公网地址免去了本地重新部署过程只需要使用公网地址直接进就可以访问本地部署的Docsify随时管理网站。
安装Cpolar内网穿透工具下面是安装cpolar步骤Cpolar官网地址: https://www.cpolar.com点击进入cpolar官网点击免费使用注册一个账号并下载最新版本的Cpolar登录成功后点击下载Cpolar到本地并安装一路默认安装即可本教程选择下载Windows版本。
Cpolar安装成功后在浏览器上访问http://localhost:9200使用cpolar账号登录,登录后即可看到Cpolar web 配置界面,结下来在web 管理界面配置即可。
配置公网地址接下来配置一下本地 Docsify 的公网地址登录后点击左侧仪表盘的隧道管理——创建隧道创建一个 个人博客网站 的公网http地址隧道隧道名称可自定义命名注意不要与已有的隧道名称重复协议选择 http本地地址3000域名类型免费选择随机域名地区选择China VIP点击创建隧道创建成功后点击左侧的状态——在线隧道列表,查看所生成的公网访问地址有两种访问方式,分别是http和https。
使用任意一个上面Cpolar生成的公网地址,在电脑或任意设备在浏览器进行登录访问,即可成功看到 本地博客网站 界面,这样一个可以远程访问的公网地址就创建好了,使用了Cpolar的公网域名,无需自己购买云服务器,即可在公网访问本地部署的服务了
配置固定公网地址我们接下来为其配置固定的HTTP端口地址该地址不会变化方便分享给别人长期查看你的本地服务而无需每天重复修改服务器地址。
配置固定http端口地址需要将cpolar升级到专业版套餐或以上。
登录cpolar官网点击左侧的预留选择保留二级子域名设置一个二级子域名名称点击保留,保留成功后复制保留的二级子域名名称。
本教程中我创建的是二级子域名是 myhugo1大家可以自定义创建。
返回登录Cpolar web UI管理界面点击左侧仪表盘的隧道管理——隧道列表找到所要配置的隧道 myblog 点击右侧的编辑修改隧道信息将保留成功的二级子域名配置到隧道中域名类型选择二级子域名Sub Domain填写保留成功的二级子域名点击更新(注意,点击一次更新即可,不需要重复提交)更新完成后,打开在线隧道列表,此时可以看到公网地址已经发生变化,地址名称也变成了固定的二级子域名名称的域名最后我们使用固定的公网地址在任何浏览器打开访问可以看到成功访问使用Docsify搭建好的本地博客网站这样一个固定且永久不变的二级子域名公网地址就设置好了。
以上就是如何在Windows系统电脑本地使用Docsify搭建一个博客网站并结合cpolar内网穿透工具实现一键发布公网随时随地远程访问的全部流程。
感谢您的观看有任何问题欢迎留言交流。
**结尾**Docsify 简化了文档网站的搭建流程cpolar 则让文档摆脱了局域网的束缚无论是个人知识管理还是团队协作都能更高效地利用文档提升工作和学习效率。
cpolar官网-安全的内网穿透工具 | 无需公网ip | 远程访问 | 搭建网站