0%

GitBook 指南

Posted on Edited on In ,
Symbols count in article: 1.4k Reading time ≈ 1 mins.

GitBook 使用指南，升级到 v3

安装

$ sudo npm install -g gitbook-cli
$ gitbook --version
CLI version: 2.3.2
GitBook version: 3.2.3

命令

$ gitbook init
$ gitbook install
$ gitbook build
$ gitbook server
$ gitbook serve --port 50000

结构

$ gitbook init
warn: no summary file in this book
info: create README.md
info: create SUMMARY.md
info: initialization is finished
$ tree
.
├── README.md
└── SUMMARY.md

book.json

可以通过配置 book.json 文件来修改 gitbook 在编译书籍时的行为，例如：修改书籍的名称，显示效果等等。

配置

plugins

GitBook 插件

  • Syntax highlighting (prism)
  • Image captions (image-captions)
  • Heading anchors (headings)
  • Easily selecting code snippet content (copy-code)
  • Algolia’s search (algolia, lunr)
  • Google Analytics (ga)
  • Edit on GitHub button (github, github-buttons)
  • Page’s table of content (atoc, toc)
  • Code block filename/tabs (codeblock-filename, code-tabs)

gitbook.com

GitBook.com 是一个围绕 gitbook 发行书籍的社区，于 2014 年初创，GitBook.com 提供免费和付费的服务

集成 GitHub

GitBook.com 还可以集成 GitHub，所以用户可以将书籍的源码通过 GitHub 上的项目来管理，这样可以使用 GitHub 带来的各种优点

GitBook -> Space -> INTEGRATIONS -> GitHub -> Select Repository

发布到 GitHub Pages

除了能够将书籍发布到 GitBook.com 外，还可以将书籍发布到 GitHub Pages，可以通过如下地址访问书籍：<username>.github.io/<project>

$ gitbook build

$ git checkout --orphan gh-pages
$ git rm --cached -r .
$ git clean -df
$ rm -rf *~

$ echo "*~" > .gitignore
$ echo "_book" >> .gitignore
$ echo "node_modules" >> .gitignore
$ git add .gitignore
$ git commit -m "Ignore some files"

$ cp -r _book/* .
$ git add .
$ git commit -m "Publish book"

$ git push -u origin gh-pages