20170125 创建说明
使用Gitbook生成在线文档的流程:
- 本机安装Node.js环境;
- 安装GitBook;
- 生成本地文档文件;
- 编辑本地文档;
- 构建静态页面;
- 将静态页面推送到GitHub Pages服务;
- 访问对应url。
注:Node.js环境只用于本机生成&编译App和静态页面,如果使用服务端自建git,服务端无需安装Node.js环境,只需同步静态页面后,用其他web容器访问静态页面即可。
配置流程
在 https://nodejs.org/ 下载并安装Node.js
安装GitBook,终端输入
npm install gitbook-cli -g
- 创建书本文件夹,初始化文件目录
gitbook init
- 编辑SUMMARY.md文件,生成目录结构
- 再次执行
gitbook init
生成文件目录 - 编辑其他.md文件,并在编辑结束后,执行
gitbook init
- 编辑中预览效果,执行
gitbook serve
- 创建静态页
gitbook build
生成_book
目录
- 使用git将所有文件夹/仅_book文件夹同步至网络服务
- 访问对应url。
注:推荐使用类GitHub Pages服务。
GitBook开源地址:https://github.com/GitbookIO/gitbook
GitBook安装说明:https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md