私有GitBook服务部署说明

20170125 创建说明

使用Gitbook生成在线文档的流程:

  1. 本机安装Node.js环境;
  2. 安装GitBook;
  3. 生成本地文档文件;
  4. 编辑本地文档;
  5. 构建静态页面;
  6. 将静态页面推送到GitHub Pages服务;
  7. 访问对应url。

注:Node.js环境只用于本机生成&编译App和静态页面,如果使用服务端自建git,服务端无需安装Node.js环境,只需同步静态页面后,用其他web容器访问静态页面即可。

配置流程

  1. 在 https://nodejs.org/ 下载并安装Node.js

  2. 安装GitBook,终端输入

npm install gitbook-cli -g
  1. 创建书本文件夹,初始化文件目录
gitbook init
  1. 编辑SUMMARY.md文件,生成目录结构
  2. 再次执行gitbook init生成文件目录
  3. 编辑其他.md文件,并在编辑结束后,执行gitbook init
  4. 编辑中预览效果,执行
gitbook serve

浏览器访问http://localhost:4000

  1. 创建静态页
gitbook build

生成_book目录

  1. 使用git将所有文件夹/仅_book文件夹同步至网络服务
  2. 访问对应url。

注:推荐使用类GitHub Pages服务。

GitBook开源地址:https://github.com/GitbookIO/gitbook

GitBook安装说明:https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md

你可能感兴趣的:(私有GitBook服务部署说明)