Gitbook是一個命令行工具谈况,可以把你的Markdown文件匯集成電子書,并提供PDF等多種格式輸出蓝仲。你可以把Gitbook生成的HTML發(fā)布出來辜梳,就形成了一個簡單的靜態(tài)網(wǎng)站。Gitbook還有一個同名的平臺(gitbook.io)胜宇,可以發(fā)布和銷售電子書耀怜,并提供了一個Markdown客戶端工具(支持Mac、Windows和Linux)幫助寫作桐愉。以下是我在使用Gitbook中的筆記财破。
首先Gitbook和Git/Github都沒有什么關(guān)系。它只是一個build book的工具而已从诲。但它的Git前綴的確引起了許多人的迷惑左痢,起初我認(rèn)為至少它也是個和Github類似的Git平臺吧,但其實沒什么關(guān)系系洛,你只要懂幾條markdown語法俊性,不必理解任何與Git相關(guān)的東西就能用Gitbook了,不要為其名字迷惑描扯。
第0步
安裝npm(Node Package Manager)定页。從node.js的官網(wǎng)上下載安裝程序,即可完成Node.js和npm的安裝绽诚。
第1步
通過npm安裝Gitbook典徊。
$ npm install gitbook -g
完成后花10分鐘閱讀下Gitbook的幫助文檔杭煎。如果你沒耐心看手冊,那就繼續(xù)往下讀吧 :D
第2步
了解Gitbook的基本規(guī)則宫峦。
Gitbook需要2個基本文件:
- README.md
- SUMMARY.md
README.md是關(guān)于你的書的介紹岔帽,而SUMMARY.md中則包含了書目,即章節(jié)結(jié)構(gòu)导绷,它的格式大致是:
* [第1章](c1.md)
* [第1節(jié)](c1s1.md)
* [第2節(jié)](c1s2.md)
* [第2章](c2.md)
剩下的東西就很好理解了犀勒,你只需要編寫相應(yīng)章節(jié)即可。在編輯完README.md和SUMMARY.md后妥曲,你可以運行以下命令:
$ gitbook serve -p 8080 .
Gitbook首先把你的Markdown文件編譯為HTML文件贾费,并根據(jù)SUMMARY.md生成書的目錄。所有生存的文件都保存在當(dāng)前目錄下的一個名為_book的子目錄中檐盟。完成這些工作后褂萧,Gitbook會作為一個HTTP Server運行,并在8080端口監(jiān)聽HTTP請求葵萎。
運行以上命令后导犹,打開瀏覽器,在地址欄輸入:http://localhost:8080
即可看到你的書頁了羡忘。
其中位于左側(cè)書目頂部的Introduction
一節(jié)就編譯自README.md谎痢,而書目本身自編譯自SUMMARY.md。你要在自己的網(wǎng)站上發(fā)布新書卷雕,只需把_book目錄復(fù)制到服務(wù)器相應(yīng)目錄即可节猿。至此Gitbook的基本用法就介紹完畢。下面簡單討論下Gitbook的其他應(yīng)用漫雕,包括Gitbook的插件滨嘱、與Github的融合、Gitbook客戶端浸间、Gitbook平臺太雨,以及Gitbook的問題。
Gitbook的插件支持
Gitbook可以生成HTML魁蒜,因此它支持一些外部的JavaScript文件嵌入到HTML中躺彬,例如Google統(tǒng)計、Disqus評論系統(tǒng)等梅惯。以下以頁面中嵌入Disqus評論為例宪拥。
首先是安裝Gitbook的Disqus插件。
$ npm install gitbook-plugin-disqus
然后建立一個book.json文件铣减,其格式如下:
{
"plugins": ["disqus"],
"pluginsConfig": {
"disqus": {
"shortName": "NAME-FROM-DISQUS"
}
}
}
把上面的NAME-FROM-DISQUS
修改為你在Disqus上的項目名即可她君。
再次運行命令:
$ gitbook serve -p 8080 .
并刷新瀏覽器,即可看到附加了Disqus評論的頁面葫哗。
與Github的融合
Gitbook的博客上說Github提供了對Gitbook的特殊支持缔刹,但我沒有測試球涛。只是依然把源文件保存在Github上,然后用Gitbook去編譯校镐。期待Gitbook做的更好亿扁。
Gitbook客戶端
Gitbook客戶端支持Mac、Windows鸟廓、Linux从祝。我在Mac和Windows簡單嘗試了這個客戶端,總體而言可以用引谜。但也僅僅是可以用而已牍陌。你可以在客戶端里編輯Markdown文件,并提供一個實時的預(yù)覽窗口员咽;可以關(guān)聯(lián)到你的Gitbook賬戶毒涧,并把內(nèi)容同步到gitbook.io,并為你生成PDF等贝室。說句題外話契讲,如果你要Markdown的客戶端的話,飛象馬克更好用滑频,至少Vim編輯模式你得支持啊怀泊。
生成圖書
當(dāng)你在自己的電腦上編輯好圖書之后,你可以使用Gitbook
的命令行進(jìn)行本地預(yù)覽:
$ gitbook serve .
然后瀏覽器中輸入 http://localhost:4000 就可以預(yù)覽生
成的以網(wǎng)頁形式組織的書籍误趴。
這里你會發(fā)現(xiàn),你在你的圖書項目的目錄中多了一個名為
_book的文件目錄务傲,而這個目錄中的文件凉当,即是生成的靜態(tài)
網(wǎng)站內(nèi)容。
使用build參數(shù)生成到指定目錄
與直接預(yù)覽生成的靜態(tài)網(wǎng)站文件不一樣的是售葡,使用這個命令看杭,
你可以將內(nèi)容輸入到你所想要的目錄中去:
$ mkdir /tmp/gitbook
$ gitbook build --output=/tmp/gitbook
輸出PDF文件
輸入為PDF文件,需要先使用NPM安裝上gitbook pdf:
$ sudo npm install gitbook-pdf -g