介紹
GitBook是一個基於Node.js的命令行工具,可使用 Github/Git和Markdown來制作精美的電子書,GitBook 並非關 Git的教程。
導出格式有PDF、HTML等,需要添加相應插件。
安裝
安裝npm
從網站 https://nodejs.org/en/download/ 上下載並安裝
npm -v
查看是否安裝成功。
安裝gitbook
npm install -g gitbook-cli
gitbook -V
查看是否安裝成功。
安裝GitBook Editor
這是官方的一個客戶端編輯器。可以不安裝,直接在GitBook網站上編輯文檔也是可以的。
下載地址:https://www.gitbook.com/editor
現在的版本是7.0.12,如果要切換到Markdown編輯器,右下角有個按鈕,點擊然后選擇“Edit Markdown”即可使用Markdown編輯器。如果是舊的版本,
使用
直接使用
在頁面上,直接點擊“+New Book”,根據提示即可創建一本書,然后就可以進行編輯了。
可用editor編輯,也可以網站上直接編輯。
關聯GitHub
GitHub:先在上GitHub創建一個倉庫。
GitBook:然后在GitBook右上角的個人信息那里,點擊“Account Settings”,在界面上選擇“GitHub”這個Tab,找到“Integration”選項卡,有一個按鈕“Install GitHub integration on this account”,點擊,選擇剛剛在GitHub創建的倉庫即可。
注意:后續如果還需要繼續做關聯,在GitHub網站的Setting中的“Intalled GitHub Apps”,對GitBook進行配置即可。
GitBook:創建一個新書,然后點擊setting,有一個GitHub選項卡,選擇關聯的GitHub倉庫即可。
現在就可用editor編輯,也可以網站上直接編輯,還可以用GitHub進行管理了。
文件結構
除了README.md,還需要SUMMARY.md這個文件,這個是書的結構,如下:
# Summary
* 第一章
* [第一節](di-yi-zhang/di-yi-jie.md)
* [第二節](di-yi-zhang/di-er-jie.md)
* 第二章
* 第三章
文件夾“di-yi-zhang”跟SUMMARY.md都在根目錄。
默認情況下,如果是直接在網頁上編輯的,目錄跟文件名都會是拼音,當然可以自己命名。
導出
導出HTML,會在_book文件夾下生成文件
gitbook build
如果是要導出PDF,ePub或者mobi格式的電子書時,需要安裝Calibre電子書閱讀/管理器和命令行工具,不然可能會報錯“EbookError: Error during ebook generation: 'ebook-convert'”。
導出PDF
gitbook pdf
其他功能
https://chrisniael.gitbooks.io/gitbook-documentation/content/index.html
插件搜索地址:https://plugins.gitbook.com/