如何寫一本靜態(tài)網(wǎng)站的書籍-GitBook(Mac)

序言

首先看下我們要實(shí)現(xiàn)的效果是怎么樣的。通過(guò)下面的圖片季眷,可以看到墓猎,左邊就是書籍目錄的導(dǎo)航欄,導(dǎo)航欄的上面還有全局搜索功能(每一個(gè)子目錄的內(nèi)容都可以搜到)邓线,內(nèi)容的顯示界面還可以選擇幾個(gè)閱讀風(fēng)格(A)淌友。個(gè)人覺(jué)得比電子書還方便,有興趣的可以玩一下骇陈。資料整理歸類的超方便震庭。
接下來(lái)要講的就是如何實(shí)現(xiàn)了,我這里用的gitbook你雌。也可以說(shuō)是gitbook的教程吧器联。


gitbook基本界面.png

GitBook 是一個(gè)基于 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 來(lái)制作精美的電子書婿崭,GitBook 并非關(guān)于 Git的教程拨拓。

1.安裝

1.1安裝npm

從網(wǎng)站 https://nodejs.org/#download 下載node.apk 安裝即可

// 檢查npm是否安裝成功 
npm -v 
// 檢查node是否存在 
node -v

1.2安裝gitbook


// 安裝Gitbook命令(mac要用這個(gè)才能成功安裝)
sudo npm install -g gitbook-cli
// 檢查是否安裝成功
gitbook -v
  • 注意事項(xiàng)

  • 不能使用 npm install gitbook -g 命令安裝,因?yàn)槭褂妹頶itbook的時(shí)候會(huì)出現(xiàn)問(wèn)題氓栈。
  • 安裝的命令前需要加入sudo,因?yàn)榭赡軙?huì)找不到npm的 /usr/local/bin/路徑渣磷。
  • 使用gitbook -v命令檢查時(shí)可能會(huì)不出現(xiàn)版本號(hào),但其實(shí)是安裝好了授瘦。

2.使用

Gitbook的基本規(guī)則
Gitbook需要2個(gè)基本文件:

  • 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)
  * [第1節(jié)](c2s1.md) 
  * [第2節(jié)](c2s2.md)

2.1根據(jù)目錄生成圖書結(jié)構(gòu)

2.1.1 README.md 與 SUMMARY編寫

  • README.md

這個(gè)文件相當(dāng)于一本Gitbook的簡(jiǎn)介物独。

//創(chuàng)建目錄/test_gitbook
mkdir test_gitbook
//新建文件README.md
touch README.md
  • SUMMARY.md

這個(gè)文件是一本書的目錄結(jié)構(gòu),使用Markdown語(yǔ)法氯葬,如我們這本書的SUMMARY.md:

// 創(chuàng)建文件
touch SUMMARY.md
// 此命令為終端改寫文件(不方便)挡篓,建議直接用Markdown軟件直接編寫
vim SUMMARY.md

SUMMARY.md文件的編寫
輸入

* [簡(jiǎn)介](README.md)
  * [第一章](chapter1/chapter1.md) 
    * [第一節(jié)](chapter1/section1.md)  
    * [第二節(jié)](chapter1/section2.md)
  * [第二章](chapter2/chapter2.md) 
    * [第一節(jié)](chapter2/section1.md) 
    * [第二節(jié)](chapter2/section2.md)
* [結(jié)束](end/README.md)

2.2 生成圖書結(jié)構(gòu)

當(dāng)這個(gè)目錄文件創(chuàng)建好之后,我們可以使用Gitbook的命令行工具將這個(gè)目錄結(jié)構(gòu)生成相應(yīng)的目錄及文件:

gitbook init
// 查看建立的目錄和文件,此命令需要安裝 tree、 安裝tree的終端命令:brew install tree
tree 

目錄如下:

.
├── chapter1
│    ├── chapter1.md
│    ├── section1.md
│    └── section2.md
├── chapter2
│     ├── chapter2.md
│     ├── section1.md
│     └── section2.md
├── end
│     └── README.md
├── README.md
└── SUMMARY.md

可以看到官研,gitbook生成了與SUMMARY.md所對(duì)應(yīng)的目錄及文件秽澳。
每個(gè)目錄中,都有一個(gè)README.md文件戏羽,相當(dāng)于一章的說(shuō)明担神。
生成圖書

2.2 輸出為靜態(tài)網(wǎng)站

2.2.1 本地預(yù)覽時(shí)自動(dòng)生成

編輯好圖書之后,使用Gitbook的命令行進(jìn)行本地預(yù)覽:

//該操作需在文件路徑下
gitbook serve

然后瀏覽器中輸入 http://localhost:4000 就可以預(yù)覽生成的以網(wǎng)頁(yè)形式組織的書籍始花。

同時(shí)圖書項(xiàng)目的目錄中多了_book的文件目錄妄讯,而這個(gè)目錄中的文件,即是生成的靜態(tài)網(wǎng)站內(nèi)容酷宵。(用這個(gè)命令生成的靜態(tài)網(wǎng)站亥贸,在沒(méi)有服務(wù)器的情況下,不能返回首頁(yè)浇垦,
如果想要_book的內(nèi)容在本地被訪問(wèn)炕置,可以使用以前的gitbook版本生成,我這里用的是2.6.7)

//用指定版本的gitbook生成
gitbook build --gitbook=2.6.7

使用build參數(shù)將文件生成到指定目錄:

//新建目錄
mkdir /tmp/gitbook
//輸出到制定目錄
gitbook build --output=/tmp/gitbook

2.2.2 輸出PDF

使用Gitbook寫開源書籍男韧,過(guò)一把作家癮

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末朴摊,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子此虑,更是在濱河造成了極大的恐慌仍劈,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,941評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件寡壮,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡讹弯,警方通過(guò)查閱死者的電腦和手機(jī)况既,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,397評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)组民,“玉大人棒仍,你說(shuō)我怎么就攤上這事〕羰ぃ” “怎么了莫其?”我有些...
    開封第一講書人閱讀 165,345評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)耸三。 經(jīng)常有香客問(wèn)我乱陡,道長(zhǎng),這世上最難降的妖魔是什么仪壮? 我笑而不...
    開封第一講書人閱讀 58,851評(píng)論 1 295
  • 正文 為了忘掉前任憨颠,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘爽彤。我一直安慰自己养盗,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,868評(píng)論 6 392
  • 文/花漫 我一把揭開白布适篙。 她就那樣靜靜地躺著往核,像睡著了一般。 火紅的嫁衣襯著肌膚如雪嚷节。 梳的紋絲不亂的頭發(fā)上聂儒,一...
    開封第一講書人閱讀 51,688評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音丹喻,去河邊找鬼薄货。 笑死,一個(gè)胖子當(dāng)著我的面吹牛碍论,可吹牛的內(nèi)容都是我干的谅猾。 我是一名探鬼主播,決...
    沈念sama閱讀 40,414評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼鳍悠,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼税娜!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起藏研,我...
    開封第一講書人閱讀 39,319評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤敬矩,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后蠢挡,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體弧岳,經(jīng)...
    沈念sama閱讀 45,775評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評(píng)論 3 336
  • 正文 我和宋清朗相戀三年业踏,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了禽炬。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,096評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡勤家,死狀恐怖腹尖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情伐脖,我是刑警寧澤热幔,帶...
    沈念sama閱讀 35,789評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站讼庇,受9級(jí)特大地震影響绎巨,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜蠕啄,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,437評(píng)論 3 331
  • 文/蒙蒙 一认烁、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦却嗡、人聲如沸舶沛。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,993評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)如庭。三九已至,卻和暖如春撼港,著一層夾襖步出監(jiān)牢的瞬間坪它,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,107評(píng)論 1 271
  • 我被黑心中介騙來(lái)泰國(guó)打工帝牡, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留往毡,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,308評(píng)論 3 372
  • 正文 我出身青樓靶溜,卻偏偏與公主長(zhǎng)得像开瞭,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子罩息,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,037評(píng)論 2 355

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