本地部署Docsify生成文档网站并实现公网环境远程访问

首页 > 博客 > Windows > 本地部署Docsify生成文档网站并实现公网环境远程访问

前言

本文主要介绍如何在Windows环境本地部署 Docsify 这款以 markdown 为中心的文档编辑器，并即时生成您的文档博客网站，结合cpolar内网穿透还能将博客一键发布至公网允许所有人访问，无需公网IP，也不用设置路由器那么麻烦。

Docsify它会智能地加载和解析您的 Markdown 文件，并将它们显示为网站，无需构建，写完文档保存完直接同步发布，不同于GitBook、Hexo的地方是它不会生成静态的.html文件，所有转换工作都是在运行时。如果你想要开始使用他，只需要创建一个index.html就可以开始编写文档并直接部署在GitHub Pages。

它的主要特性如下：

无需构建，写完文档直接发布（运行时markdown文档转换）
容易使用并且轻量（压缩后 ~21kB，当然这里不包括markdown文档的大小）
智能的全文搜索
丰富的API
支持Emoji，可以在文中添加表情
兼容IE11
支持服务端渲染SSR

接下来，讲解如何在本地部署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，随时管理网站。