利用docsify创建文档网站(手摸手教程)

一、前言

docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件，所有转换工作都是在运行时进行。
这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 .html 文件“污染” commit 记录，只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。

二、环境

使用docsify-cli 开发 docsify文档网站比较方便，但是需要先安装node
node安装教程可以参考 nodejs安装图文教程

三、安装

1、初始化

1. 创建一个文件夹 ，例如叫 docs

2. 在docs目录下安装 docsify-cli

npm i docsify-cli -g

安装完成后使用以下命令查看是否安装完成

docsify -v

3. 初始化项目

docsify init 

初始化成功后,docsify目录会生成如下几个文件：

index.html入口文件
README.md会做为主页内容渲染
.nojekyll用于阻止 GitHub Pages 会忽略掉下划线开头的文件

 .nojekyll文件很重要，如果网站部署到GitHub Pages时，一定要注意这个文件。

2、启动服务

1. 启动服务

docsify serve

然后浏览器打开http://localhost:3000就能看见效果。