[gitbook] - gitbook的簡單使用

GitBook 是一個基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 來制作精美的電子書歉提。
GitBook支持輸出以下幾種文檔格式:

  • 靜態(tài)站點:GitBook默認(rèn)輸出該種格式
  • PDF:需要安裝gitbook-pdf依賴
  • eBook:需要安裝ebook-convert

1钠四、gitbook的安裝

首先要確保安裝了node (node -v 檢測是否安裝,未安裝去node官網(wǎng)下載安裝)
然后安裝gitbook:

sudo npm install gitbook-cli -g   // 安裝gitbook
gitbook --version  // 查看是否安裝成功
gitbook help  // 查看gitbook命令

2梅垄、簡單使用

  • 使用 gitbook init 初始化書籍目錄
  • 使用 gitbook serve 編譯書籍

首先射富,創(chuàng)建如下目錄結(jié)構(gòu):(README.md、SUMMARY.md2個必要文件)

book/
├── README.md
└── SUMMARY.md

其中 README.md 是對書籍的簡單介紹:

$ cat book/README.md 
# README 
This is a book

SUMMARY.md是書籍的目錄結(jié)構(gòu):

$ cat book/SUMMARY.md 
# SUMMARY
* [Chapter1](chapter1/README.md)
  * [Section1.1](chapter1/section1.1.md)
  * [Section1.2](chapter1/section1.2.md)
* [Chapter2](chapter2/README.md)

創(chuàng)建2個文件后,使用gitbook init 翔悠,它會為我們創(chuàng)建 SUMMARY.md中的目錄結(jié)構(gòu)

書籍目錄創(chuàng)建成功后,就可以使用gitbook serve來編譯和預(yù)覽書籍了R懊ⅰ蓄愁!
gitbook serve命令實際上會先調(diào)用gitbook build編譯書籍,完成以后會打開一個web服務(wù)器狞悲,監(jiān)聽在本地的4000端口撮抓。

3、結(jié)合github存儲書籍

創(chuàng)建 gh-pages 分支 用于展示靜態(tài)資源
執(zhí)行如下命令來創(chuàng)建分支摇锋,并且刪除不需要的文件:(實際中只用了git checkout --orphan gh-pages)

$ git checkout --orphan gh-pages
$ git rm --cached -r .
$ git clean -df
$ rm -rf *~

現(xiàn)在丹拯,目錄下應(yīng)該只剩下 _book 目錄了,首先荸恕,忽略一些文件:

$ echo "*~" > .gitignore
$ echo "_book" >> .gitignore
$ git add .gitignore
$ git commit -m "Ignore some files"

然后乖酬,加入 _book 下的內(nèi)容到分支中:

$ cp -r _book/* .
$ git add .
$ git commit -m "Publish book"

然后就可以訪問 用戶名+ github.io + 項目名稱,例如https://wylibra.github.io/gitbook

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市融求,隨后出現(xiàn)的幾起案子咬像,更是在濱河造成了極大的恐慌,老刑警劉巖生宛,帶你破解...
    沈念sama閱讀 216,591評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件县昂,死亡現(xiàn)場離奇詭異,居然都是意外死亡陷舅,警方通過查閱死者的電腦和手機(jī)倒彰,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,448評論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來莱睁,“玉大人待讳,你說我怎么就攤上這事⊙鼋耍” “怎么了耙箍?”我有些...
    開封第一講書人閱讀 162,823評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長酥馍。 經(jīng)常有香客問我辩昆,道長,這世上最難降的妖魔是什么旨袒? 我笑而不...
    開封第一講書人閱讀 58,204評論 1 292
  • 正文 為了忘掉前任汁针,我火速辦了婚禮,結(jié)果婚禮上砚尽,老公的妹妹穿的比我還像新娘施无。我一直安慰自己,他們只是感情好必孤,可當(dāng)我...
    茶點故事閱讀 67,228評論 6 388
  • 文/花漫 我一把揭開白布猾骡。 她就那樣靜靜地躺著瑞躺,像睡著了一般。 火紅的嫁衣襯著肌膚如雪兴想。 梳的紋絲不亂的頭發(fā)上幢哨,一...
    開封第一講書人閱讀 51,190評論 1 299
  • 那天,我揣著相機(jī)與錄音嫂便,去河邊找鬼捞镰。 笑死,一個胖子當(dāng)著我的面吹牛毙替,可吹牛的內(nèi)容都是我干的岸售。 我是一名探鬼主播,決...
    沈念sama閱讀 40,078評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼厂画,長吁一口氣:“原來是場噩夢啊……” “哼凸丸!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起袱院,我...
    開封第一講書人閱讀 38,923評論 0 274
  • 序言:老撾萬榮一對情侶失蹤甲雅,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后坑填,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體抛人,經(jīng)...
    沈念sama閱讀 45,334評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,550評論 2 333
  • 正文 我和宋清朗相戀三年脐瑰,在試婚紗的時候發(fā)現(xiàn)自己被綠了妖枚。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,727評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡苍在,死狀恐怖绝页,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情寂恬,我是刑警寧澤续誉,帶...
    沈念sama閱讀 35,428評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站初肉,受9級特大地震影響酷鸦,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜牙咏,卻給世界環(huán)境...
    茶點故事閱讀 41,022評論 3 326
  • 文/蒙蒙 一臼隔、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧妄壶,春花似錦摔握、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,672評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽泊愧。三九已至,卻和暖如春盛正,著一層夾襖步出監(jiān)牢的瞬間删咱,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,826評論 1 269
  • 我被黑心中介騙來泰國打工蛮艰, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人雀彼。 一個月前我還...
    沈念sama閱讀 47,734評論 2 368
  • 正文 我出身青樓壤蚜,卻偏偏與公主長得像,于是被迫代替她去往敵國和親徊哑。 傳聞我的和親對象是個殘疾皇子袜刷,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,619評論 2 354

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