当前位置：首页 > news >正文

新手小白如何使用docsify本地搭建一个文档网站并一键发布公网

news 来源：原创 2025/6/28 22:03:34

文章目录

- 前言
- 1. 本地部署Docsify
- 2. 使用Docsify搭建个人博客
- 3. 安装Cpolar内网穿透工具
- 4. 配置公网地址
- 5. 配置固定公网地址

前言

在数字化的大潮中，内容创作已经变得不可或缺。然而，如何高效地管理和分享这些内容却成了一个让人头疼的问题。传统的静态站点生成器如GitBook和Hexo虽然强大，但复杂的步骤常常让人心生退意。今天，我要给大家介绍一款神器——Docsify！这款工具不仅能让技术博主、开发者以及任何需要频繁撰写文档的人士工作变得轻松愉快，还能让你的文档瞬间变成一个美轮美奂的网站，并通过Cpolar内网穿透工具轻松发布到公网。再也不用担心复杂的路由器设置或高昂的公网IP费用了，只需几行简单的配置，你的内容就能迅速飞向全世界！无论是个人项目还是团队协作，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本地全局工具

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 -->

![logo](_media/icon.svg)

# docsify <small>3.5</small>

> 一个神奇的文档网站生成器。

- 简单、轻便 (压缩后 ~21kB)
- 无需生成 html 文件
- 众多主题

[开始使用 Let Go](/README.md)

继续回到我们刚才搭建的页面，打开一个新的浏览器，输入localhost:3000，或者本机IP地址:3000

这样我们就在本地搭建了一个简单的个人文档博客，博客排版风格也可以自己随意设计，但是目前我们已经在本地搭建好了博客网站，如果没有公网IP的话，只能在本地局域网环境使用，有一定的局限性。如果出门在外想远程访问使用的话，可以结合cpolar内网穿透生成公网地址，免去了本地重新部署过程，只需要使用公网地址直接进就可以访问本地部署的Docsify，随时管理网站。