GitBook 是一款基于 Node.js 開(kāi)發(fā)的開(kāi)源的工具茸俭,可以通過(guò)命令行的方式創(chuàng)建電子書(shū)項(xiàng)目吊履,再使用 MarkDown 編寫(xiě)電子書(shū)內(nèi)容,然后生成 PDF调鬓、ePub艇炎、mobi 格式的電子書(shū),或生成一個(gè)靜態(tài)站點(diǎn)腾窝。
除此之外冕臭,還可以利用 Git 命令管理電子書(shū)版本腺晾。如果你是 GitHub 的重度使用者,還可以把你的 GitBook 帳戶和 GitHub 帳戶關(guān)聯(lián)起來(lái)辜贵,這樣不論在任何一方修改了內(nèi)容悯蝉,都可以互相同步。
一托慨、安裝 Node.js
由于 GitBook 是基于 Node.js 開(kāi)發(fā)的鼻由,所以依賴 Node.js 環(huán)境。如果您的系統(tǒng)中還未安裝 Node.js厚棵,請(qǐng)點(diǎn)擊下面的鏈接蕉世,根據(jù)你所使用的系統(tǒng)下載對(duì)應(yīng)的版本。如果已安裝則略過(guò)本步驟婆硬。
Node.js 下載頁(yè)面:https://nodejs.org/en/download/stable/
Windows 版和 Mac 版的 Node.js 都是常規(guī)的安裝包狠轻,連續(xù)下一步安裝即可。Lunix 版可以參照官方文檔通過(guò) yum彬犯、apt-get 之類的工具安裝向楼,也可以通過(guò)源碼包安裝,如下所示:
$ wget https://nodejs.org/dist/v5.4.1/node-v5.4.1.tar.gz$ tar zxvf node-v5.4.1.tar.gz$ cd node-v5.4.1$ ./configure$ make$ make install
二谐区、安裝 GitBook
打開(kāi)“命令提示符”(Mac 系統(tǒng)打開(kāi)“終端”)輸入以下命令安裝 GitBook:
$ npm install gitbook-cli -g
由于網(wǎng)絡(luò)的原因湖蜕,安裝的時(shí)間可能會(huì)較長(zhǎng)一些,請(qǐng)耐心等待直到安裝完成宋列。安裝完成后可以輸入以下命令昭抒,以查看 GitBook 版本的方式檢查是否安裝成功:
$ gitbook -V
三、創(chuàng)建電子書(shū)項(xiàng)目
新建一個(gè)目錄炼杖,并進(jìn)入該目錄使用 gitbook 命令初始化電子書(shū)項(xiàng)目灭返。舉個(gè)例子,現(xiàn)在要?jiǎng)?chuàng)建一個(gè)名為“MyFirstBook”的空白電子書(shū)項(xiàng)目坤邪,如下所示:
$ mkdir MyFirstBook
$ cd MyFirstBook
$ gitbook init
四熙含、編輯電子書(shū)內(nèi)容
初始化后的目錄中會(huì)出現(xiàn)“README.md(電子書(shū)簡(jiǎn)介文件)”和“SUMMARY.md(導(dǎo)航目錄文件)”兩個(gè)基本文件。除此之外還可以手動(dòng)新建其它“Glossary.md(書(shū)尾的詞匯表)”罩扇、“book.json(電子書(shū)配置文件)”婆芦。
電子書(shū)的正文內(nèi)容可以根據(jù)自己的喜好創(chuàng)建新的后綴為 .md 文件怕磨,如“chapter01.md”喂饥,然后用 MarkDown 編寫(xiě)具體的文本內(nèi)容即可。下面對(duì)這些文件分別做詳細(xì)介紹肠鲫。
1员帮、README.md
此文件是簡(jiǎn)單的電子書(shū)介紹,可以把您所制作的電子書(shū)做一下簡(jiǎn)單的描述:
# 簡(jiǎn)介
這是我的第一本使用 GitBook 制作的電子書(shū)导饲。
2捞高、SUMMARY.md
此為電子書(shū)的導(dǎo)航目錄文件氯材,每當(dāng)新增一個(gè)章節(jié)文件就需要向此文件中添加一條記錄。對(duì)于 Kindle 電子書(shū)來(lái)說(shuō)硝岗,此文件所呈現(xiàn)的目錄結(jié)構(gòu)就是開(kāi)頭的目錄內(nèi)容和“前往”的目錄導(dǎo)航氢哮。
# Summary
* [簡(jiǎn)介](README.md)
* [第一章](section1/README.md)
* [第二章](section2/README.md)
如果需要“子章節(jié)”可以使用 Tab
縮進(jìn)來(lái)實(shí)現(xiàn)(最多支持三級(jí)標(biāo)題),如下所示:
# Summary
* [第一章](section1/README.md)
* [第一節(jié)](section1/example1.md)
* [第二節(jié)](section1/example2.md)
* [第二章](section2/README.md)
* [第一節(jié)](section2/example1.md)
3型檀、Glossary.md
對(duì)于電子書(shū)內(nèi)容中需要解釋的詞匯可在此文件中定義冗尤。詞匯表會(huì)被放在電子書(shū)末尾。其格式如下所示:
# 電子書(shū)
電子書(shū)是指將文字胀溺、圖片裂七、聲音、影像等訊息內(nèi)容數(shù)字化的出版物和植入或下載數(shù)字化文字仓坞、圖片背零、聲音、影像等訊息內(nèi)容的集存儲(chǔ)和顯示終端于一體的手持閱讀器无埃。
# Kindle
Amazon Kindle 是由 Amazon 設(shè)計(jì)和銷售的電子書(shū)閱讀器(以及軟件平臺(tái))徙瓶。用戶可以通過(guò)無(wú)線網(wǎng)絡(luò)使用 Amazon Kindle 購(gòu)買(mǎi)、下載和閱讀電子書(shū)录语、報(bào)紙倍啥、雜志、博客及其他電子媒體澎埠。
4虽缕、book.json
“book.json”是電子書(shū)的配置文件,可以看作是電子書(shū)的“原數(shù)據(jù)”蒲稳,比如 title氮趋、description、isbn江耀、language剩胁、direction、styles 等祥国,更多點(diǎn)擊這里查看昵观。它的基本結(jié)構(gòu)如下所示:
{
"title": "我的第一本電子書(shū)",
"description": "用 GitBook 制作的第一本電子書(shū)!",
"isbn": "978-3-16-148410-0",
"language": "zh-tw",
"direction": "ltr"
}
5舌稀、普通章節(jié).md 文件
普通章節(jié).md 文件可以使用您感覺(jué)順手的文本編輯器編寫(xiě)啊犬。MarkDown 的寫(xiě)法可以點(diǎn)擊這里查看相關(guān)示例。每編寫(xiě)一個(gè) .md 文件壁查,不要忘了在“SUMMARY.md”文件中添加一條記錄哦觉至。
6、電子書(shū)封面圖片
GitBook 幫助文檔建議封面圖片的尺寸為 1800*2360 像素并且遵循建議:
- 沒(méi)有邊框
- 清晰可見(jiàn)的書(shū)本標(biāo)題
- 任何重要的文字在小版本中應(yīng)該可見(jiàn)
圖片的格式為 jpg 格式睡腿。把圖片重命名為“cover.jpg”放到電子書(shū)項(xiàng)目文件夾即可语御。
五峻贮、預(yù)覽電子書(shū)內(nèi)容
電子書(shū)內(nèi)容編寫(xiě)完畢后可以使用瀏覽器預(yù)覽一下。先輸入下面的命令據(jù) .md 文件生成 HTML 文檔:
$ gitbook build
生成完畢后应闯,會(huì)在電子書(shū)項(xiàng)目目錄中出現(xiàn)一個(gè)名為“_book”的文件夾纤控。進(jìn)入該文件夾,直接用瀏覽器打開(kāi)“index.html”碉纺,或先輸入下面的命令:
$ gitbook serve
然后在瀏覽器中輸入“http://localhost:4000”即可預(yù)覽電子書(shū)內(nèi)容嚼黔,預(yù)覽完畢后按 Ctrl + C
結(jié)束。
六惜辑、生成電子書(shū)文件
確定電子書(shū)沒(méi)有問(wèn)題后唬涧,可以通過(guò)輸入以下命令生成 mobi 電子書(shū):
$ gitbook mobi ./ ./MyFirstBook.mobi
如果出現(xiàn)以下錯(cuò)誤提示,說(shuō)明您還未安裝 Calibre盛撑。由于 GitBook 生成 mobi 格式電子書(shū)依賴 Calibre 的 ebook-convert碎节,所以請(qǐng)先點(diǎn)擊這里下載安裝 Calibre。
Error: Need to install ebook-convert from Calibre
Calibre 安裝完畢后抵卫,對(duì)于 Mac OS X 系統(tǒng)狮荔,還需要先設(shè)置一下軟鏈接:
$ ln -s /Applications/calibre.app/Contents/MacOS/ebook-convert /usr/local/bin
再次運(yùn)行轉(zhuǎn)換命令,即可生成 mobi 格式電子書(shū)介粘。
七殖氏、把項(xiàng)目托管到 GitBook.com
以上所有的步驟都是在本地進(jìn)行的,如果需要實(shí)現(xiàn)電子書(shū)的版本管理姻采,或者把電子書(shū)發(fā)布到網(wǎng)絡(luò)上雅采,還可以通過(guò) Git 命令將本地的項(xiàng)目托管到 GitBook.com 上。
1慨亲、注冊(cè) GitHub.com 賬號(hào)
首先進(jìn)入 GitBook.com 注冊(cè)一個(gè)賬號(hào)婚瓜,并新建一個(gè)項(xiàng)目。在“Setting(設(shè)置)”頁(yè)面獲取到“Git URL(Git 鏈接)”刑棵,鏈接的樣子如下所示:
https://git.gitbook.com/kindlefere/myfirstbook.git
2巴刻、安裝 Git 軟件
在開(kāi)始下面的步驟之前請(qǐng)先確保您的系統(tǒng)中已經(jīng)安裝了 Git。一般 Mac 和 Lunix 自帶 Git 功能蛉签,可以在終端運(yùn)行 git --version
查看 Git 版本胡陪。Windows 一般不會(huì)自帶 Git 功能,請(qǐng)點(diǎn)擊這里下載先安裝碍舍。
在安裝 Windows 版的 Git 時(shí)柠座,會(huì)看到“Use Git from Git Bash only”和“Use Git from the Windows Command prompt”兩個(gè)選項(xiàng)。前者指的在程序自帶的獨(dú)立終端中使用 Git乒验。后者是指可以通過(guò)系統(tǒng)自帶的“命令提示符”使用 Git 命令愚隧⊙诟颍可以根據(jù)自己的喜好選擇撼嗓,個(gè)人推薦使用后者。
3捞稿、上傳已有的電子書(shū)項(xiàng)目
在本地新建一個(gè)文件夾鳄厌,并通過(guò) Git 命令把剛才新建的遠(yuǎn)程項(xiàng)目抓取到本地荞胡,如下所示:
$ mkdir MyFirstBook-Git$ cd MyFirstBook-Git
$ git init$ git pull https://git.gitbook.com/kindlefere/myfirstbook.git
然后把本地項(xiàng)目“MyFirstBook”中的所有內(nèi)容拷貝到剛才新建的文件夾中,如上面的“MyFirstBook-Git”了嚎。然后使用 Git 命令把本地的項(xiàng)目上傳到遠(yuǎn)程泪漂,如下所示:
$ git add -A$ git commit -m "提交說(shuō)明"
$ git remote add gitbook https://git.gitbook.com/kindlefere/myfirstbook.git
$ git push -u gitbook master
期間需要輸入你的 GitBook 注冊(cè)郵箱和密碼。今后修改內(nèi)容后只需要輸入以下 Git 命令即可:
$ git add [修改的文件]$ git commit -m "提交說(shuō)明"
$ git push -u gitbook master
八歪泳、把項(xiàng)目關(guān)聯(lián)到 GitHub 帳戶
如果你喜歡使用 GitHub 管理項(xiàng)目萝勤。還可以把您的 GitBook 帳戶和 GitHub 帳戶關(guān)聯(lián)起來(lái),這樣兩者的修改內(nèi)容就可以互相同步了呐伞。
1敌卓、關(guān)聯(lián) GitBook 和 GitHub 帳戶
關(guān)聯(lián)設(shè)置也很簡(jiǎn)單,首先進(jìn)入 GitBook 的“Account Settings(帳戶設(shè)置)”頁(yè)面伶氢,在“Profile(個(gè)人資料)”標(biāo)簽頁(yè)找到“GitHub”選項(xiàng)卡趟径,點(diǎn)擊【Connect to GitHub】按鈕會(huì)轉(zhuǎn)向 GitHub 的“Authorize application”頁(yè)面,點(diǎn)擊【Authorize application】按鈕即可完成關(guān)聯(lián)癣防。
2蜗巧、把 GitBook 項(xiàng)目導(dǎo)入到 GitHub
完成關(guān)聯(lián)后即可設(shè)置同步電子書(shū)項(xiàng)目了。以電子書(shū)項(xiàng)目“MyFirstBook”為例蕾盯,首先需要把項(xiàng)目導(dǎo)入到 GitHub 中一份幕屹。進(jìn)入某個(gè)電子書(shū)項(xiàng)目的設(shè)置頁(yè)面,切換到“GitHub”選項(xiàng)卡级遭。在“GitHub Repository”中香嗓,點(diǎn)擊【Export to GitHub】按鈕,按照向?qū)静襟E將項(xiàng)目導(dǎo)入 GitHub 中装畅。
3靠娱、設(shè)置 GitBook 和 GitHuB 同步
導(dǎo)出成功后,再回到 GitBook 項(xiàng)目設(shè)置頁(yè)面的“GitHub”選項(xiàng)卡掠兄,在“GitHub Repository”中的輸入框中填入 GitHub 的 Repository 名像云,如“GitHub用戶名/myfirstbook”,點(diǎn)擊【Save】按鈕保存蚂夕。
保存后當(dāng)前頁(yè)面會(huì)出現(xiàn)一個(gè)名為“Integration”的選項(xiàng)卡迅诬,點(diǎn)擊里面的【Add webhook】按鈕,允許 GitBook 接收 Github 的內(nèi)容更新婿牍。這樣就把 GitBook 上的項(xiàng)目和 GitHub 相對(duì)應(yīng)的項(xiàng)目關(guān)聯(lián)上了侈贷。
此后即可用 GitHub 管理電子書(shū)項(xiàng)目,在 GitBook 上對(duì)電子書(shū)內(nèi)容修改也會(huì)自動(dòng)同步到 GitHub 中等脂。