参考

npm install gitbook-cli -g
cd youBookRootDir
gitbook init
gitbook serve

# gitbook build ./ --log=debug --debug
gitbook build

目录结构

.
├── cover.jpg           // 可选: 转换为电子书时,使用的封面
├── book.json           // 可选: 配置文件
├── README.md           // 必须: 前言、简介
├── SUMMARY.md          // 必须: ToC 目录
├── GLOSSARY.md         // 可选: 术语表
├── chapter-1/
|   ├── README.md       // 每个章节特定的说明文档
|   └── something.md
└── chapter-2/
    ├── README.md
    └── something.md

gitbook 从 .gitignore, .bookignore 和 .ignore 中读取要忽略的文件。其他静态文件都复制到输出目录中

插件

# 1. 先修改 book.json 追加plugins的名称
plugins : ["mathjax"]

# 2. 再在命令安装插件
gitbook install

常用插件

mathjax

$$x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}$$ $x=\frac{-b\pm\sqrt{b^2-4ac}}{2a}$

输出

需要先安装一定的必要软件, 比如 calibre。

sudo ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/bin


# 生成各种格式
gitbook pdf ./ ./mybook.pdf
gitbook epub ./ ./mybook.epub

插件 - prism

prism 插件提供了更好的代码着色配置。但是在本地启动过程中，如果发现控制台有提示 { [Error: Cannot find module 'prismjs/components/prism-cfg.js'] code: 'MODULE_NOT_FOUND' } 这样的提示，务必请查找并修改为 prism 支持的语法类型。该类型可以在 ./node_modules/prismjs/components 目录下通过文件名来快速判别。

使用其他的主题？

确保你的book目录中有 package.json （可以通过 npm init 创建）

npm install --save prism-themes

修改 book.json

{
  "pluginsConfig": {
    "prism": {
      "css": [
        "prism-themes/themes/prism-duotone-dark.css"
      ]
    }
  }
}

默认插件

主题

theme-default 是默认主题。

字体

fontsettings

travis-ci 构建

生成一个 github Personal access tokens
在 gitbook 中对单个 repo 进行配置，追加环境变量 https://travis-ci.org/<me>/<myrepo>/settings
```
 GITHUB_API_KEY=<token>
```
并确保没有启用 "Display value in build log"

修改 .travis.yml :

 after_success: |
     if [ -n "$GITHUB_API_KEY" ]; then
         cd "$TRAVIS_BUILD_DIR"
         # This generates a `web` directory containing the website.
         make web
         cd web
         git init
         git checkout -b gh-pages
         git add .
         git -c user.name='travis' -c user.email='travis' commit -m init
         # Make sure to make the output quiet, or else the API token will leak!
         # This works because the API key can replace your password.
         git push -f -q https://<me>:$GITHUB_API_KEY@github.com/<me>/<myrepo>-gh-pages gh-pages &2>/dev/null
         cd "$TRAVIS_BUILD_DIR"
     fi