使用Docsify搭建文档类型网站

docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地方是，它不会生成静态的 .html 文件，所有转换工作都是在运行时。如果你想要开始使用它，只需要创建一个 index.html 就可以开始编写文档并直接部署在 GitHub Pages。

Docsify官方文档：https://docsify.js.org/#/zh-cn/

安装 docsify-cli 工具

推荐全局安装 docsify-cli 工具，可以方便地创建及在本地预览生成的文档。

npm i docsify-cli -g

初始化项目

# 初始化目录
docsify init docs
# 启动一个本地服务器，可以方便地实时预览效果。默认访问地址 http://localhost:3000
docsify serve docs

初始化成功后，可以看到 ./docs 目录下创建的几个文件

• index.html 入口文件
• README.md 会做为主页内容渲染
• .nojekyll 用于阻止 GitHub Pages 忽略掉下划线开头的文件
• 直接编辑 docs/README.md 就能更新文档内容，当然也可以添加更多页面。

部署到服务器

若在linux部署，不需要安装docsify，只需将服务器的访问根目录设定为 index.html 文件即可。

修改nginx配置后，reload一下：

./nginx -s reload

---

效果演示

win10 本地 Typora 目录结构

笔记记在 Typora 中，注意设置一下图片存储路径，这样就可以在粘贴图片的之后自动生成相对路径，便于部署

设置方式：

相对路径效果：

整个目录结构：

服务器上运行效果

在本地修改之后，直接 push 到 github，可以在linux服务器上写一个自动拉取脚本，即可同步更新页面，非常方便。

---

附：Linux 安装 npm 方法（部署不需要安装npm）

###### 安装npm（实际上，部署不需要安装npm...） ######
# 淘宝镜像，下载node，解压
wget https://npm.taobao.org/mirrors/node/latest-v14.x/node-v14.15.3-linux-x64.tar.gz
tar -zxvf node-v14.15.3-linux-x64.tar.gz
# 添加软链接
ln -s /usr/local/node/node-v14.15.3-linux-x64/bin/npm /usr/local/bin/npm
ln -s /usr/local/node/node-v14.15.3-linux-x64/bin/node /usr/local/bin/node
# 安装成功，查看版本
npm -v