docsify导出html,Docsify生成文档网站

Docsify生成文档网站

1. docsify简介

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

docsify能你快速的搭建一个小型的文档网站，只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。

2. docsify入门案例

开启docsify第一个案例，需要安装Node.js以及docsify-cli工具。

2.1 安装Node.js

2.2 docsify-cli

docsify-cli是生成docsify项目的小工具。使用以下命令全局安装docsify-cli，安装完成查看版本

#全局安装docsify-cli

npm i docsify-cli -g

#查看版本

docsify -v

2.3 初始化项目

创建一个项目根目录,用来存放案例

mkdir docsifyDemo

进入项目根目录并初始化

docsify init ./docs

查看生成的目录和文件

tree /f

生成目录和文件

─docs

--.nojekyll 用于阻止 GitHub Pages 会忽略掉下划线开头的文件

--index.html 入口文件

--README.md 主页内容渲染

2.4 启动项目

运行服务

docsify serve ./docs

默认访问

http://localhost:3000

访问效果

3. docsify 实战