我的GitBook筆記

最近準(zhǔn)備寫一本書，所以研究研究GitBook，本文對學(xué)習(xí)做個記錄，主要目就是以后日常使用，就不用去翻看別的資料了。

什么是GitBook

GitBook 是一個基于 Node.js 的命令行工具，可使用 Github/Git 和 Markdown 來制作精美的電子書。

• GitBook項目官網(wǎng)
• GitBook Github地址

GitBook需要使用markdown格式編寫，如果你不了解可以看看這里。

安裝

需要先安裝Node，安裝步驟網(wǎng)上教程非常多，在此不詳細(xì)介紹，安裝好node后就可以使用npm安裝GitBook了。

gitbook-cli

需要先安裝gitbook-cli，這個工具是用來管理gitbook工具的，這有點類似容器的意思，通過gitbook-cli可以在本地安裝多個gitbook工具的不同版本。

使用如下命令安裝GitBook。

 $ npm install gitbook-cli -g

安裝完之后，你可以檢驗下是否安裝成功。

$ gitbook -V

安裝gitbook

安裝完gitbook-cli后，要使用gitbook還需要安裝gitbook工具，可以通過如下命令安裝。

$ gitbook versions:install

安裝好后可以通過如下命令查看是否安裝成功。

$ gitbook versions

都安裝好后接下來我們就可以做點有意思的事情了。

常用命令

再開始做有意思的事情之前，先來熟悉下常用命令。

gitbook-cli常用命令

gitbook -h # 查看幫助信息

gitbook versions # 查看本地安裝的gitbook版本

gitbook versions:install # 安裝最新版gitbook
gitbook versions:install 2.3.3 # 安裝指定版本

gitbook versions:uninstall # 卸載當(dāng)前選中版本
gitbook versions:uninstall 2.3.3 # 卸載指定版本

gitbook versions:link # 指定當(dāng)前文件夾使用當(dāng)前選中版本
gitbook versions:link 2.3.3 # 指定當(dāng)前文件夾使用指定版本
gitbook versions:link path # 指定path使用指定版本

gitbook -v 2.3.3 # 指定當(dāng)前使用哪個版本的gitbook
gitbook --gitbook 2.3.3 # 同上

gitbook常用命令

$ gitbook init # 初始化一個倉庫

$ gitbook install # 安裝插件

$ gitbook serve [book] # 本地預(yù)覽
$ gitbook serve --port 8001 # 指定端口

$ gitbook build repository PATH # 輸出一個靜態(tài)網(wǎng)站

$ gitbook pdf book pdf # 生成pdf文件

$ gitbook help # 查看幫助

順便吐槽一下gitbook命令設(shè)計是有問題，兩個不同的命令耦合在了一起。

圖書項目結(jié)構(gòu)

README.md和SUMMARY.md是Gitbook項目必備的兩個文件，也就是一本最簡單的GitBook也必須含有這兩個文件，它們在一本Gitbook中具有不同的用處。

README.md

這個文件相當(dāng)于一本Gitbook的簡介。

SUMMARY.md

這個文件是一本書的目錄結(jié)構(gòu)，使用Markdown語法，一個簡單的例子如下所示。

# Summary

* [Part I](part1/README.md)
    * [Writing is nice](part1/writing.md)
    * [GitBook is nice](part1/gitbook.md)
* [Part II](part2/README.md)
    * [We love feedback](part2/feedback_please.md)
    * [Better tools for authors](part2/better_tools.md)

更多信息請看這里。

book.json

自從GitBook 2.0.0開始支持自定義簡介文件，在book.json中定義，這樣README.md就可以用作項目的簡介。

{
    "structure": {
        "readme": "myIntro.md"
    }
}

更多信息請看這里。

book.json還有自定義更多的信息，比如網(wǎng)頁的title，description等，全部可配置信息請查看這里。

發(fā)布

使用gitbook可以很方便的發(fā)布到很多平臺下面舉幾個常用的例子。

發(fā)布到GitHub

源代碼保存到master分支，build出來的上傳到gh-pages分支，就這么簡單的搞定了。如果你還不會使用git和github，那么不妨讀讀我的另一篇文章《我的git筆記》。

發(fā)布PDF

這里已windows平臺為例子，需要先安裝calibre@2.38.0（其實只是需要ebook-convert這個工具），安裝好后將其安裝目錄配置到PATH。

然后就可以使用下面的命令生成pdf了。

$ gitbook pdf . ../temp.pdf # 將當(dāng)前目錄，生成到父目錄下的temp.pdf

發(fā)布到GitBook

還沒想好，想好了再寫。

總結(jié)

關(guān)于GitBook的更多資料可查看官網(wǎng)的幫助文檔，哪里的介紹比較全面，也會保持時時更新。

參考資料

• Gitbook 使用入門