GitBook入门

一、介绍

GitBook 是一个基于 Node.js 的命令行工具，可使用 Github/Git 和 Markdown来制作精美的电子书，GitBook 并非关于 [Git]的教程。

node 环境

执行 gitbook init时， 发现报错如下。

Error loading version latest: Error: Cannot find module 'internal/util/types'
    at Function.Module._resolveFilename (module.js:538:15)
    at Function.Module._load (module.js:468:25)
    at Module.require (module.js:587:17)
    at require (internal/module.js:11:18)
    at evalmachine.<anonymous>:31:26
    at Object.<anonymous> (/Users/vspt/.gitbook/versions/2.6.6/node_modules/graceful-fs/fs.js:11:1)
    at Module._compile (module.js:643:30)
    at Object.Module._extensions..js (module.js:654:10)
    at Module.load (module.js:556:32)
    at tryModuleLoad (module.js:499:12)

TypeError: Cannot read property 'commands' of null

问题原因 Gitbook 只支持 node 6.x.x版本，node版本不对，使用n或者nvm切换node版本重新安装 gitbook-cli

二、安装gitbook-cli

npm install -g gitbook-cli

三、初始化

新建gitbook-demo文件夹，初始化：

gitbook init

四、目录

README.md —— 书籍的介绍写在这个文件里
SUMMARY.md —— 书籍的目录结构在这里配置

QQ20200115-161730.png

五、编辑SUMMARY.md

# 目录 SUMMARY.md

* [前言](README.md)
* [第一章](Chapter1/README.md)
  * [第1节：1](Chapter1/1.md)
  * [第2节：2](Chapter1/2.md)
  * [第3节：3](Chapter1/3.md)
  * [第4节：4](Chapter1/4.md)
* [第二章](Chapter2/README.md)
* [第三章](Chapter3/README.md)
* [第四章](Chapter4/README.md)

再次执行gitbook init，根据SUMMARY.md里的章节内容，创建新的文件夹和md文件。

QQ20200115-162624.png

六、启动 gitbook 项目

启动本地服务: gitbook serve

gitbook serve

QQ20200115-163829@2x.png

程序无报错则可以在浏览器预览电子书效果: http://localhost:4000 。能够实时预览电子书效果。

七、构建 gitbook 静态网页

gitbook build

构建静态网页而不启动本地服务器,默认生成文件存放在 _book/ 目录，输出静态网页后可打包上传到服务器，也可以上传到 github 等网站进行托管,因而主要用于发布准备阶段。

 

总结

gitbook init   //初始化 README.md 和 SUMMARY.md 两个文件. 
gitbook build  //本地构建但不运行服务,默认输出到 _book/ 目录. 
gitbook serve  //本地构建并运行服务,默认访问 http://localhost:4000 实时预览。