GitBook 簡(jiǎn)介

GitBook是一個(gè)基于 Node.js 的命令行工具，可使用 Github/Git 和 Markdown 來(lái)制作精美的電子書，GitBook 并非關(guān)于 Git 的教程。
GitBook支持輸出多種文檔格式：

• 靜態(tài)站點(diǎn)：GitBook默認(rèn)輸出該種格式，生成的靜態(tài)站點(diǎn)可直接托管搭載Github Pages服務(wù)上；
• PDF：需要安裝gitbook-pdf依賴；
• eBook：需要安裝ebook-convert；
• 單HTML網(wǎng)頁(yè)：支持將內(nèi)容輸出為單頁(yè)的HTML，不過一般用在將電子書格式轉(zhuǎn)換為PDF或eBook的中間過程；
• JSON：一般用于電子書的調(diào)試或元數(shù)據(jù)提取。
  使用GitBook制作電子書，必備兩個(gè)文件：README.md和SUMMARY.md 。
• GitBook 官網(wǎng)
• GitBook 文檔

GitBook 準(zhǔn)備工作

GitBook 是一個(gè)基于 Node.js 的命令行工具，下載安裝 Node.js，安裝完成之后，你可以使用下面的命令來(lái)檢驗(yàn)是否安裝成功。

$ node -v
v10.15.3

安裝 GitBook

輸入下面的命令來(lái)安裝 GitBook

$ npm install gitbook-cli -g

安裝完成之后，你可以使用下面的命令來(lái)檢驗(yàn)是否安裝成功。（這里的V是大寫的哦?。?/p>

$ gitbook -V
CLI version: 2.3.2
GitBook version: 3.2.3

創(chuàng)建一本書

初始化
GitBook可以設(shè)置一個(gè)樣板書：

$ gitbook init

如果您希望將書籍創(chuàng)建到一個(gè)新目錄中，可以通過運(yùn)行 gitbook init ./directory

構(gòu)建

如果你下載了一本gitbook，你需要切換到書所在的目錄使用下面的命令，會(huì)在項(xiàng)目的目錄下生成一個(gè) _book 目錄，里面的內(nèi)容為靜態(tài)站點(diǎn)的資源文件。

$ gitbook build

image.png

$ gitbook serve

GitBook 命令

這里主要介紹一下 GitBook 的命令行工具 gitbook-cli 的一些命令, 首先說(shuō)明兩點(diǎn):

• gitbook-cli 和 gitbook 是兩個(gè)軟件
• gitbook-cli 會(huì)將下載的 gitbook 的不同版本放到 ~/.gitbook中, 可以通過設(shè)置GITBOOK_DIR環(huán)境變量來(lái)指定另外的文件夾

列出 gitbook 所有的命令

$ gitbook help

輸出 gitbook-cli 的幫助信息

$ gitbook --help

生成靜態(tài)網(wǎng)頁(yè)

$ gitbook build

生成靜態(tài)網(wǎng)頁(yè)并運(yùn)行服務(wù)器

$ gitbook serve

生成時(shí)指定gitbook的版本, 本地沒有會(huì)先下載

$ gitbook build --gitbook=2.0.1

列出本地所有的gitbook版本

$ gitbook ls

列出遠(yuǎn)程可用的gitbook版本

$ gitbook ls-remote

安裝對(duì)應(yīng)的gitbook版本

$ gitbook fetch 標(biāo)簽/版本號(hào)

更新到gitbook的最新版本

$ gitbook update

卸載對(duì)應(yīng)的gitbook版本

$ gitbook uninstall 2.3.2

指定log的級(jí)別

$ gitbook build --log=debug

輸出錯(cuò)誤信息

$ gitbook builid --debug

GitBook 項(xiàng)目結(jié)構(gòu)

GitBook使用簡(jiǎn)單的目錄結(jié)構(gòu)。在 SUMMARY （即 SUMMARY.md 文件）中列出的所有 Markdown / Asciidoc 文件將被轉(zhuǎn)換為 HTML。多語(yǔ)言書籍結(jié)構(gòu)略有不同。

GitBook 電子書結(jié)構(gòu)如下所示：

.
├── book.json
├── README.md
├── SUMMARY.md
├── chapter-1/
|   ├── README.md
|   └── something.md
└── chapter-2/
    ├── README.md
    └── something.md

文件介紹：