00. 目錄
01. 什麼是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
。
02. 爲什麼用GitBook
一般來說,我們最開始學習和使用的辦公軟件就是 Word、Excel 和 PowerPoint。這裏不是說它們已經過時了,不是說 GitBook 能夠替代它們。
相反,Microsoft 的辦公軟件很優秀並且經受了時間的考驗,但是正因爲它功能豐富,導致稍顯臃腫(二八定律:80%的時間裏我們只會只用20%的功能),同時因爲它存在以二進制格式保存、軟件不兼容、格式不兼容、難以進行版本控制、難以實時分享預覽、難以多人協作等短板。而這恰恰是 GitBook + Markdown + Git 的長處。
簡單來說,GitBook + Markdown + Git 帶來的好處有:
- 語法簡單
- 兼容性強
- 導出方便
- 團隊協作
所以,如果你和我一樣,不滿足於傳統的寫作方式,正在尋找一種令人愉悅的寫作方式,那麼該嘗試使用 GitBook 啦!
當然,GitBook 不是萬能的,當我們需要複雜排版時,依然需要依託於 Word 等工具。但不用擔心,因爲我們可以把 Markdown 格式的文檔導出爲 Word 格式,再進一步加工。
03. 怎麼安裝GitBook
當你聽了我的慫恿,並決定嘗試使用 GitBook 的時候,首先面臨的問題是 —— 如何搭建 GitBook 環境?
因爲 GitBook 是基於 Node.js,所以我們首先需要安裝 Node.js(下載地址:https://nodejs.org/en/download/),找到對應平臺的版本安裝即可。
現在安裝 Node.js 都會默認安裝 npm(node 包管理工具),所以我們不用單獨安裝 npm,打開命令行,執行以下命令安裝 GitBook:
sudo npm install gitbook-cli -g
安裝完之後,就會多了一個 gitbook 命令(如果沒有,請確認上面的命令是否加了 -g)。
上面我推薦的是 GitBook + Typora + Git,所以你還需要安裝 Typora(一個很棒的支持 macOS、Windows、Linux 的 Markdown 編輯工具)和 Git 版本管理工具。下載鏈接如下:
- Typora 下載地址:https://typora.io/
- Git 下載地址:https://git-scm.com/downloads
- Git教程:【Tools】Windows下Git 2.18安裝步驟
- Typora下載:typora-setup-x64-20200701.rar
04. 怎麼使用GitBook
想象一下,現在你準備構建一本書籍,你在硬盤上新建了一個叫 book的文件夾,按照以前的做法,你會新建一個 Word 文檔,寫上標題,然後開始編輯內容。但是現在有了 GitBook,你首先要做的是在 book文件夾下執行以下命令:
gitbook init
打開一個文件夾 book使用 gitbook init 初始化文件夾,會自動生成兩個必要的文件 README.md
和 SUMMARY.md
文件 | 說明 |
---|---|
README.md | 書的介紹文字,如前言、簡介,在章節中也可做爲章節的簡介。 |
SUMMARY.md | 定製書籍的章節結構和順序。 |
編輯 SUMMARY.md 文件,內容修改爲
# Introduction
# 目錄
* [前言](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)
在 book文件夾中再次執行gitbook init
命令。GitBook 會查找 SUMMARY.md 文件中描述的目錄和文件,如果沒有則會將其創建。
Typora 是所見即所得(實時渲染)的 Markdown 編輯器,這時候它是這樣的:
接着我們執行 gitbook serve
來預覽這本書籍,執行命令後會對 Markdown 格式的文檔進行轉換,默認轉換爲 html 格式。
deng@itcast:/mnt/hgfs/LinuxHome/book1$ gitbook serve
Live reload server started on port: 35729
Press CTRL+C to quit ...
info: 7 plugins are installed
info: loading plugin "livereload"... OK
info: loading plugin "highlight"... OK
info: loading plugin "search"... OK
info: loading plugin "lunr"... OK
info: loading plugin "sharing"... OK
info: loading plugin "fontsettings"... OK
info: loading plugin "theme-default"... OK
info: found 9 pages
info: found 4 asset files
info: >> generation finished with success in 1.4s !
Starting server ...
Serving book on http://localhost:4000
使用瀏覽器輸入IP:4000
當我們寫得差不多,你可以執行 gitbook build
命令構建書籍,默認將生成的靜態網站輸出到 _book 目錄。實際上,這一步也包含在 gitbook serve
裏面,因爲它們是 HTML,所以 GitBook 通過 Node.js 給你提供服務了。
當然,build 命令可以指定路徑:
gitbook build [書籍路徑] [輸出路徑]
serve 命令也可以指定端口:
gitbook serve --port 10086
生成 PDF 格式的電子書:
gitbook pdf ./ ./mybook.pdf
生成 epub 格式的電子書:
gitbook epub ./ ./mybook.epub
生成 mobi 格式的電子書:
gitbook mobi ./ ./mybook.mobi
除此之外,可以用 Git 做版本管理。在 book 目錄下執行 git init 初始化倉庫,執行 git remote add 添加遠程倉庫(你得先在遠端建好)。接着就可以愉快地 commit,push,pull … 啦!
不是程序員的小夥伴可能不太喜歡用命令行,那其實版本管理這部分可以下載安裝 Git 或 GitHub 這些客戶端程序,在圖形界面上操作也是可以完成工作的。
05. 附錄
5.1 GitBook簡明教程
網址:https://blog.csdn.net/dengjin20104042056/article/details/107059577
5.2 GitBook官方參考手冊
下載:https://download.csdn.net/download/dengjin20104042056/12567114