Gitbook安裝與使用教程

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末挟伙,一起剝皮案震驚了整個濱河市楼雹,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌尖阔,老刑警劉巖贮缅,帶你破解...
    沈念sama閱讀 218,386評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異介却,居然都是意外死亡谴供,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,142評論 3 394
  • 文/潘曉璐 我一進(jìn)店門齿坷,熙熙樓的掌柜王于貴愁眉苦臉地迎上來桂肌,“玉大人数焊,你說我怎么就攤上這事∑槌。” “怎么了佩耳?”我有些...
    開封第一講書人閱讀 164,704評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長谭跨。 經(jīng)常有香客問我干厚,道長,這世上最難降的妖魔是什么饺蚊? 我笑而不...
    開封第一講書人閱讀 58,702評論 1 294
  • 正文 為了忘掉前任萍诱,我火速辦了婚禮,結(jié)果婚禮上污呼,老公的妹妹穿的比我還像新娘裕坊。我一直安慰自己,他們只是感情好燕酷,可當(dāng)我...
    茶點故事閱讀 67,716評論 6 392
  • 文/花漫 我一把揭開白布籍凝。 她就那樣靜靜地躺著,像睡著了一般苗缩。 火紅的嫁衣襯著肌膚如雪饵蒂。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,573評論 1 305
  • 那天酱讶,我揣著相機(jī)與錄音退盯,去河邊找鬼。 笑死泻肯,一個胖子當(dāng)著我的面吹牛渊迁,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播灶挟,決...
    沈念sama閱讀 40,314評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼琉朽,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了稚铣?” 一聲冷哼從身側(cè)響起箱叁,我...
    開封第一講書人閱讀 39,230評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎惕医,沒想到半個月后耕漱,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,680評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡抬伺,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,873評論 3 336
  • 正文 我和宋清朗相戀三年孤个,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片沛简。...
    茶點故事閱讀 39,991評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡齐鲤,死狀恐怖斥废,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情给郊,我是刑警寧澤牡肉,帶...
    沈念sama閱讀 35,706評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站淆九,受9級特大地震影響统锤,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜炭庙,卻給世界環(huán)境...
    茶點故事閱讀 41,329評論 3 330
  • 文/蒙蒙 一饲窿、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧焕蹄,春花似錦逾雄、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,910評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至永品,卻和暖如春做鹰,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背鼎姐。 一陣腳步聲響...
    開封第一講書人閱讀 33,038評論 1 270
  • 我被黑心中介騙來泰國打工钾麸, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人炕桨。 一個月前我還...
    沈念sama閱讀 48,158評論 3 370
  • 正文 我出身青樓饭尝,卻偏偏與公主長得像,于是被迫代替她去往敵國和親谋作。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,941評論 2 355

推薦閱讀更多精彩內(nèi)容

  • 本文詳細(xì)講解了 Gitbook 生成電子書的完整過程乎芳,內(nèi)容包括:安裝遵蚜、命令、配置奈惑、文檔結(jié)構(gòu)吭净、生成電子書、部署肴甸。限于...
    靜默虛空閱讀 11,256評論 9 138
  • 轉(zhuǎn)載請注明出處原在,謝謝 初級(適合沒有編程基礎(chǔ)的童鞋看) 使用GitBook Editor 寫開源書籍 這個是git...
    全科閱讀 14,942評論 25 110
  • 開發(fā)中我們正面臨的問題... API發(fā)展的當(dāng)下與趨勢標(biāo)準(zhǔn)化API越來越多跨平臺調(diào)用需求越來越普及開放平臺普及化 A...
    特里斯譚閱讀 4,737評論 3 62
  • 一次又一次的降溫秽浇,才讓樹葉變黃; 一回又一回的漠視甚负,才把人心變涼柬焕; 讓一個人沉默的,是另一個人的冷漠梭域; 讓一顆心受...
    奮鬥boy閱讀 617評論 0 0
  • 今天這一課只要是去美國的同學(xué)們斑举,想必都會用得到,我們講的是美國人民生命中必不可少的東西——咖啡! 今天我們就來當(dāng)一...
    午后窗臺的貓閱讀 505評論 0 0