Docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会将 `.md` 转成 `.html` 文件，所有转换工作都是在运行时进行。

这非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 `.html` 文件“污染” commit 记录，只需要创建一个 `index.html` 就可以开始写文档，可以直接部署在 GitHub Pages，也可以部署在云上。

本文将介绍如何在[滴滴云](https://blog.didiyun.com)上部署 Docsify 。

# 一、前置条件
在安装 Docsify 之前，需要先购买一台 DC2 云服务器，并安装 Node 环境。如果已经安装成功，可直接跳至安装 Docsify 部分。

### 1.1 购买云服务器
首先我们需要有一台云服务器来部署服务，可在[滴滴云](https://blog.didiyun.com)上进行购买。具体的购买步骤可参考[帮助文档](https://help.didiyun.com/hc/kb/article/1145869/)。

下面我们看到的是已经购买好的云服务器。配置为 **2 核 4G**, 系统为 **CentOS7.6** 。

![](http://img.blog.itpub.net/blog/2018/12/26/4f1435abf4329187.png?x-oss-process=style/bb)

购买完毕后，远程登录服务器，进行服务安装的安装与部署。以 dc2-user 的身份登录后，可以通过 `sudo su` 来切换至管理员身份进行安装。

### 1.2 安装 Node
我们将 Node 服务安装在 `/usr/local` 目录下：
```bash
## 下载node
cd /usr/local/src
wget https://nodejs.org/dist/v8.9.0/node-v8.9.0-linux-x64.tar.xz
## 解压
tar xf node-v8.9.0-linux-x64.tar.xz
cd /usr/local
## 重命名
mv src/node-v8.9.0-linux-x64 node

## 将node添加至path
vi ~/.bashrc
export NODE_HOME=/usr/local/node
export PATH=$NODE_HOME/bin:$PATH
source ~/.bashrc

## 安装成功
node -v  // 安装成功会显示Node版本

```
# 二、安装 Docsify
### 2.1 安装 Docsify
```
npm i docsify-cli -g
```
### 2.2 初始化文档目录
```
docsify init ./docs // 会在当前目录下创建docs目录，里面的内容将会作为文档内容展示
```
可以看到，文档目录下有这两个文件：
```
[root@1-1-1-1 docs]# ls 
index.html  README.md
```
其中 `index.html` 是入口文件，`README.md` 会做为主页内容渲染。
### 2.3 预览
运行一个本地服务器通过 Docsify Serve 可以方便的预览效果，而且提供 LiveReload 功能，可以让实时的预览。默认访问 http://ip:3000 。
```
docsify serve docs
```

![](http://img.blog.itpub.net/blog/2018/12/26/293e2d50a5b31d07.jpeg?x-oss-process=style/bb)

文档内容丰富之后，可达到[官网](https://docsify.js.org/#/?id=docsify)类似效果。

![](http://img.blog.itpub.net/blog/2018/12/26/fcb203398557e544.jpeg?x-oss-process=style/bb)

# 三、使用 Nginx 代理
实际工作中，我们很多服务都是配在 Nginx 里，方便使用 Nginx 的负载均衡、权限控制等功能。

### 3.1 Nginx 安装
可参考 [CentOS7 安装 Nginx 的两种方式](https://blog.didiyun.com/index.php/2018/11/16/centos7-nginx/) 这篇文档在[滴滴云](https://blog.didiyun.com)上安装 Nginx。

### 3.2 Nginx 配置
下面是一个 Nginx 配置的示例，注意自己的 server name 需要进行替换：
```
server {
      listen 80;
      server_name your_server_name; ## 这里需要写自己的服务器名称

root /usr/libra/docs; ## docsify创建的目录
      set $node_port 3000;

index index.js index.html index.htm;

location / {
        proxy_http_version 1.1;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $http_host;
        proxy_set_header X-NginX-Proxy true;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_pass http://127.0.0.1:$node_port$request_uri;
        proxy_redirect off;
      }
    }
```
配置完成后，我们就可以通过 80 端口访问文档服务了。

文档系统有很多，GitBook 也是非常好的文档工具，可参考 [在滴滴云 DC2 上基于 Gitbook+Nginx 构建轻量级文档管理服务](https://blog.didiyun.com/index.php/2018/11/15/dc2-gitbooknginx/) 这篇文档搭建 GitBook 服务。

ITPub博客

基于滴滴云搭建轻量文档网站生成工具 Docsify

最新文章