gitbook

是什么?

在我認(rèn)識(shí) GitBook 之前,我已經(jīng)在使用 Git 了,毋容置疑,Git 是目前世界上最先進(jìn)的分布式版本控制系統(tǒng)。

我認(rèn)為 Git 不僅是程序員管理代碼的工具,它的分布式協(xié)作方式同樣適用于很多場(chǎng)合,其中一個(gè)就是寫作(這會(huì)是一個(gè)引起社會(huì)變革的偉大的工具!)。所以在我發(fā)現(xiàn) GitBook 之前,實(shí)際上我已經(jīng)無數(shù)次想象過它的使用場(chǎng)景了。

咋一看 GitBook 的名字,你可能會(huì)認(rèn)為它是關(guān)于 Git 的一本書。而當(dāng)你有所了解之后,你也許會(huì)認(rèn)為它是一個(gè)使用 Git 構(gòu)建電子書的工具。其實(shí)不然,GitBook 與 Git 的關(guān)系,就像雷鋒塔和雷鋒那樣,沒有一點(diǎn)關(guān)系!

實(shí)際上,GitBook 是一個(gè)基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 兩種語法格式,可以輸出 HTML、PDF、eBook 等格式的電子書。所以我更喜歡把 GitBook 定義為文檔格式轉(zhuǎn)換工具。

所以,GitBook 不是 Markdown 編輯工具,也不是 Git 版本管理工具。市面上我們可以找到很多 Markdown 編輯器,比如 Typora、MacDown、Bear、MarkdownPad、MarkdownX、JetBrains’s IDE(需要安裝插件)、Atom、簡(jiǎn)書、CSDN 以及 GitBook 自家的 GitBook Editor 等等。

但 GitBook 又與 Markdown 和 Git 息息相關(guān),因?yàn)橹挥袑⑺鼈兘Y(jié)合起來使用,才能將它們的威力發(fā)揮到極致!因此,通常我們會(huì)選擇合適的 Markdown 編輯工具以獲得飛一般的寫作體驗(yàn);使用 GitBook 管理文檔,預(yù)覽、制作電子書;同時(shí)通過 Git 管理書籍內(nèi)容的變更,并將其托管到云端(比如 GitHub、GitLab、碼云,或者是自己搭建的 Git 服務(wù)器),實(shí)現(xiàn)多人協(xié)作。

實(shí)際上,GitBook Editor 對(duì)于新手來說是個(gè)不錯(cuò)的選擇,它集成了 GitBook、Git、Markdown 等功能,還支持將書籍同步到 gitbook.com 網(wǎng)站,使我們可以很方便地編輯和管理書籍。但是不幸的是,GitBook Editor 的注冊(cè)和登錄需要翻墻,即便注冊(cè)成功了也可能登錄不上,似乎是因?yàn)榫W(wǎng)站最近在升級(jí)。

因此,我推薦,也是我目前使用的搭配是 GitBook + Typora + Git。

為什么?

通常,我們最開始學(xué)習(xí)和使用的辦公軟件就是 Word、Excel 和 PowerPoint。這里不是說它們已經(jīng)過時(shí)了,不是說 GitBook 能夠替代它們。

相反,Microsoft 的辦公軟件很優(yōu)秀并且經(jīng)受了時(shí)間的考驗(yàn),但是正因?yàn)樗δ茇S富,導(dǎo)致稍顯臃腫(二八定律:80%的時(shí)間里我們只會(huì)只用20%的功能),同時(shí)因?yàn)樗嬖谝远M(jìn)制格式保存、軟件不兼容、格式不兼容、難以進(jìn)行版本控制、難以實(shí)時(shí)分享預(yù)覽、難以多人協(xié)作等短板。而這恰恰是 GitBook + Markdown + Git 的長(zhǎng)處。

簡(jiǎn)單來說,GitBook + Markdown + Git 帶來的好處有:

語法簡(jiǎn)單

兼容性強(qiáng)

導(dǎo)出方便

專注內(nèi)容

團(tuán)隊(duì)協(xié)作

所以,如果你和我一樣,不滿足于傳統(tǒng)的寫作方式,正在尋找一種令人愉悅的寫作方式,那么該嘗試使用 GitBook 啦!

當(dāng)然,GitBook 不是萬能的,當(dāng)我們需要復(fù)雜排版時(shí),依然需要依托于 Word 等工具。但不用擔(dān)心,因?yàn)槲覀兛梢园?Markdown 格式的文檔導(dǎo)出為 Word 格式,再進(jìn)一步加工。

怎么辦?

怎么安裝

當(dāng)你聽了我的慫恿,并決定嘗試使用 GitBook 的時(shí)候,首先面臨的問題是 —— 如何搭建 GitBook 環(huán)境?

因?yàn)?GitBook 是基于 Node.js,所以我們首先需要安裝 Node.js(下載地址:https://nodejs.org/en/download/),找到對(duì)應(yīng)平臺(tái)的版本安裝即可。

現(xiàn)在安裝 Node.js 都會(huì)默認(rèn)安裝 npm(node 包管理工具),所以我們不用單獨(dú)安裝 npm,打開命令行,執(zhí)行以下命令安裝 GitBook:

npm install -g gitbook-cli

1

安裝完之后,就會(huì)多了一個(gè) gitbook 命令(如果沒有,請(qǐng)確認(rèn)上面的命令是否加了 -g)。

上面我推薦的是 GitBook + Typora + Git,所以你還需要安裝 Typora(一個(gè)很棒的支持 macOS、Windows、Linux 的 Markdown 編輯工具)和 Git 版本管理工具。戳下面:

Typora 下載地址:https://typora.io/

Git 下載地址:https://git-scm.com/downloads

Typora 的安裝很簡(jiǎn)單,難點(diǎn)在于需要翻墻才能下載(當(dāng)然你也可以找我要)。Git 的安裝也很簡(jiǎn)單,但要用好它需要不少時(shí)間,這里就不展開了(再講下去怕你要跑啦~)。

怎么使用

想象一下,現(xiàn)在你準(zhǔn)備構(gòu)建一本書籍,你在硬盤上新建了一個(gè)叫 mybook 的文件夾,按照以前的做法,你會(huì)新建一個(gè) Word 文檔,寫上標(biāo)題,然后開始巴滋巴滋地筆耕。但是現(xiàn)在有了 GitBook,你首先要做的是在 mybook 文件夾下執(zhí)行以下命令:

gitbook init

1

執(zhí)行完后,你會(huì)看到多了兩個(gè)文件 —— README.md 和 SUMMARY.md,它們的作用如下:

README.md —— 書籍的介紹寫在這個(gè)文件里

SUMMARY.md —— 書籍的目錄結(jié)構(gòu)在這里配置

這時(shí)候,我們啟動(dòng)恭候多時(shí)的 Typora 來編輯這兩個(gè)文件了:

編輯 SUMMARY.md 文件,內(nèi)容修改為:

# 目錄

* [前言](README.md)

* [第一章](Chapter1/README.md)

? * [第1節(jié):衣](Chapter1/衣.md)

? * [第2節(jié):食](Chapter1/食.md)

? * [第3節(jié):住](Chapter1/住.md)

? * [第4節(jié):行](Chapter1/行.md)

* [第二章](Chapter2/README.md)

* [第三章](Chapter3/README.md)

* [第四章](Chapter4/README.md)

1

2

3

4

5

6

7

8

9

10

11

12

然后我們回到命令行,在 mybook 文件夾中再次執(zhí)行 gitbook init 命令。GitBook 會(huì)查找 SUMMARY.md 文件中描述的目錄和文件,如果沒有則會(huì)將其創(chuàng)建。

Typora 是所見即所得(實(shí)時(shí)渲染)的 Markdown 編輯器,這時(shí)候它是這樣的:

接著我們執(zhí)行 gitbook serve 來預(yù)覽這本書籍,執(zhí)行命令后會(huì)對(duì) Markdown 格式的文檔進(jìn)行轉(zhuǎn)換,默認(rèn)轉(zhuǎn)換為 html 格式,最后提示 “Serving book on http://localhost:4000”。嗯,打開瀏覽器看一下吧:

當(dāng)你寫得差不多,你可以執(zhí)行 gitbook build 命令構(gòu)建書籍,默認(rèn)將生成的靜態(tài)網(wǎng)站輸出到 _book 目錄。實(shí)際上,這一步也包含在 gitbook serve 里面,因?yàn)樗鼈兪?HTML,所以 GitBook 通過 Node.js 給你提供服務(wù)了。

當(dāng)然,build 命令可以指定路徑:

gitbook build [書籍路徑] [輸出路徑]

1

serve 命令也可以指定端口:

gitbook serve --port 2333

1

你還可以生成 PDF 格式的電子書:

gitbook pdf ./ ./mybook.pdf

1

生成 epub 格式的電子書:

gitbook epub ./ ./mybook.epub

1

生成 mobi 格式的電子書:

gitbook mobi ./ ./mybook.mobi

1

如果生成不了,你可能還需要安裝一些工具,比如 ebook-convert?;蛘咴?Typora 中安裝 Pandoc 進(jìn)行導(dǎo)出。

除此之外,別忘了還可以用 Git 做版本管理呀!在 mybook 目錄下執(zhí)行 git init 初始化倉庫,執(zhí)行 git remote add 添加遠(yuǎn)程倉庫(你得先在遠(yuǎn)端建好)。接著就可以愉快地 commit,push,pull … 啦!

不是程序員的小伙伴可能不太喜歡用命令行,那其實(shí)版本管理這部分可以下載安裝 Git 或 GitHub 這些客戶端程序,在圖形界面上操作也是可以完成工作的。

---------------------

作者:阿基米東

來源:CSDN

原文:https://blog.csdn.net/lu_embedded/article/details/81100704

版權(quán)聲明:本文為博主原創(chuàng)文章,轉(zhuǎn)載請(qǐng)附上博文鏈接!

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 前言 近期使用Typora編寫文檔的時(shí)候,寫一些篇章比較短的文章還好。但是當(dāng)篇章過長(zhǎng),標(biāo)題目錄過多的時(shí)候,那樣就會(huì)...
    Devops海洋的漁夫閱讀 12,047評(píng)論 6 59
  • 最近遇到一些問題,就是團(tuán)隊(duì)中會(huì)有些伙伴踩得坑的收集問題或者有些較為復(fù)雜的業(yè)務(wù)需求文檔共享上成本較高,所以考慮弄...
    tobAlier閱讀 4,039評(píng)論 0 5
  • 本文詳細(xì)講解了 Gitbook 生成電子書的完整過程,內(nèi)容包括:安裝、命令、配置、文檔結(jié)構(gòu)、生成電子書、部署。限于...
    靜默虛空閱讀 11,473評(píng)論 9 138
  • 參考文章:GitBook 從懵逼到入門 一、介紹 GitBook 是一個(gè)基于 Node.js 的命令行工具,可使用...
    左木北魚閱讀 26,300評(píng)論 1 41
  • 荀子說:“不積跬步,無以至千里;不積小流, 無以成江海。 ”做什么事都要先掌握這件事最基礎(chǔ)的東西,才能進(jìn)一步做好這...
    小殊閱讀 587評(píng)論 0 0

友情鏈接更多精彩內(nèi)容