gitbook

是什么?

在我認識 GitBook 之前,我已經在使用 Git 了,毋容置疑,Git 是目前世界上最先進的分布式版本控制系統。

我認為 Git 不僅是程序員管理代碼的工具,它的分布式協作方式同樣適用于很多場合,其中一個就是寫作(這會是一個引起社會變革的偉大的工具!)。所以在我發現 GitBook 之前,實際上我已經無數次想象過它的使用場景了。

咋一看 GitBook 的名字,你可能會認為它是關于 Git 的一本書。而當你有所了解之后,你也許會認為它是一個使用 Git 構建電子書的工具。其實不然,GitBook 與 Git 的關系,就像雷鋒塔和雷鋒那樣,沒有一點關系!

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

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

但 GitBook 又與 Markdown 和 Git 息息相關,因為只有將它們結合起來使用,才能將它們的威力發揮到極致!因此,通常我們會選擇合適的 Markdown 編輯工具以獲得飛一般的寫作體驗;使用 GitBook 管理文檔,預覽、制作電子書;同時通過 Git 管理書籍內容的變更,并將其托管到云端(比如 GitHub、GitLab、碼云,或者是自己搭建的 Git 服務器),實現多人協作。

實際上,GitBook Editor 對于新手來說是個不錯的選擇,它集成了 GitBook、Git、Markdown 等功能,還支持將書籍同步到 gitbook.com 網站,使我們可以很方便地編輯和管理書籍。但是不幸的是,GitBook Editor 的注冊和登錄需要翻墻,即便注冊成功了也可能登錄不上,似乎是因為網站最近在升級。

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

為什么?

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

相反,Microsoft 的辦公軟件很優秀并且經受了時間的考驗,但是正因為它功能豐富,導致稍顯臃腫(二八定律:80%的時間里我們只會只用20%的功能),同時因為它存在以二進制格式保存、軟件不兼容、格式不兼容、難以進行版本控制、難以實時分享預覽、難以多人協作等短板。而這恰恰是 GitBook + Markdown + Git 的長處。

簡單來說,GitBook + Markdown + Git 帶來的好處有:

語法簡單

兼容性強

導出方便

專注內容

團隊協作

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

當然,GitBook 不是萬能的,當我們需要復雜排版時,依然需要依托于 Word 等工具。但不用擔心,因為我們可以把 Markdown 格式的文檔導出為 Word 格式,再進一步加工。

怎么辦?

怎么安裝

當你聽了我的慫恿,并決定嘗試使用 GitBook 的時候,首先面臨的問題是 —— 如何搭建 GitBook 環境?

因為 GitBook 是基于 Node.js,所以我們首先需要安裝 Node.js(下載地址:https://nodejs.org/en/download/),找到對應平臺的版本安裝即可。

現在安裝 Node.js 都會默認安裝 npm(node 包管理工具),所以我們不用單獨安裝 npm,打開命令行,執行以下命令安裝 GitBook:

npm install -g gitbook-cli

1

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

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

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

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

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

怎么使用

想象一下,現在你準備構建一本書籍,你在硬盤上新建了一個叫 mybook 的文件夾,按照以前的做法,你會新建一個 Word 文檔,寫上標題,然后開始巴滋巴滋地筆耕。但是現在有了 GitBook,你首先要做的是在 mybook 文件夾下執行以下命令:

gitbook init

1

執行完后,你會看到多了兩個文件 —— README.md 和 SUMMARY.md,它們的作用如下:

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

SUMMARY.md —— 書籍的目錄結構在這里配置

這時候,我們啟動恭候多時的 Typora 來編輯這兩個文件了:

編輯 SUMMARY.md 文件,內容修改為:

# 目錄

* [前言](README.md)

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

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

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

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

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

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

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

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

1

2

3

4

5

6

7

8

9

10

11

12

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

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

接著我們執行 gitbook serve 來預覽這本書籍,執行命令后會對 Markdown 格式的文檔進行轉換,默認轉換為 html 格式,最后提示 “Serving book on http://localhost:4000”。嗯,打開瀏覽器看一下吧:

當你寫得差不多,你可以執行 gitbook build 命令構建書籍,默認將生成的靜態網站輸出到 _book 目錄。實際上,這一步也包含在 gitbook serve 里面,因為它們是 HTML,所以 GitBook 通過 Node.js 給你提供服務了。

當然,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 進行導出。

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

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

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

作者:阿基米東

來源:CSDN

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

版權聲明:本文為博主原創文章,轉載請附上博文鏈接!

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,106評論 6 542
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,441評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,211評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,736評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,475評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,834評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,829評論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,009評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,559評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,306評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,516評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,038評論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,728評論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,132評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,443評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,249評論 3 399
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,484評論 2 379

推薦閱讀更多精彩內容