【Tools】GitBook入门教程
00. 目錄
文章目錄
- 00. 目錄
- 01. 什么是GitBook
- 02. 為什么用GitBook
- 03. 怎么安裝GitBook
- 04. 怎么使用GitBook
- 05. 附錄
01. 什么是GitBook
在我認(rèn)識 GitBook 之前,我已經(jīng)在使用 Git 了,毋容置疑,Git 是目前世界上最好用的分布式版本控制系統(tǒng)。
我認(rèn)為 Git 不僅是程序員管理代碼的工具,它的分布式協(xié)作方式同樣適用于很多場合,其中一個就是寫作(這會是一個引起社會變革的偉大的工具!)。所以在我發(fā)現(xiàn) GitBook 之前,實(shí)際上我已經(jīng)無數(shù)次想象過它的使用場景了。
咋一看 GitBook 的名字,你可能會認(rèn)為它是關(guān)于 Git 的一本書。而當(dāng)你有所了解之后,你也許會認(rèn)為它是一個使用 Git 構(gòu)建電子書的工具。其實(shí)不然,GitBook 與 Git 的關(guān)系,就像雷鋒塔和雷鋒那樣,沒有一點(diǎn)關(guān)系!
實(shí)際上,GitBook 是一個基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 兩種語法格式,可以輸出 HTML、PDF、eBook 等格式的電子書。所以我更喜歡把 GitBook 定義為文檔格式轉(zhuǎn)換工具。
所以,GitBook 不是 Markdown 編輯工具,也不是 Git 版本管理工具。市面上我們可以找到很多 Markdown 編輯器,比如 Typora、MacDown、Bear、MarkdownPad、MarkdownX、JetBrains’s IDE(需要安裝插件)、Atom、簡書、CSDN 以及 GitBook 自家的 GitBook Editor 等等。
但 GitBook 與 Markdown 和 Git 息息相關(guān),因?yàn)橹挥袑⑺鼈兘Y(jié)合起來使用,才能將它們的威力發(fā)揮到極致!因此,通常我們會選擇合適的 Markdown 編輯工具以獲得飛一般的寫作體驗(yàn);使用 GitBook 管理文檔,預(yù)覽、制作電子書;同時(shí)通過 Git 管理書籍內(nèi)容的變更,并將其托管到云端(比如 GitHub、GitLab、碼云,或者是自己搭建的 Git 服務(wù)器),實(shí)現(xiàn)多人協(xié)作。
實(shí)際上,GitBook Editor 對于新手來說是個不錯的選擇,它集成了 GitBook、Git、Markdown 等功能,還支持將書籍同步到 gitbook.com 網(wǎng)站,使我們可以很方便地編輯和管理書籍。但是不幸的是,GitBook Editor 的注冊和登錄需要翻墻,即便注冊成功了也可能登錄不上,似乎是因?yàn)榫W(wǎng)站最近在升級。
因此我們目前使用的搭配是 GitBook + Typora + Git。
02. 為什么用GitBook
一般來說,我們最開始學(xué)習(xí)和使用的辦公軟件就是 Word、Excel 和 PowerPoint。這里不是說它們已經(jīng)過時(shí)了,不是說 GitBook 能夠替代它們。
相反,Microsoft 的辦公軟件很優(yōu)秀并且經(jīng)受了時(shí)間的考驗(yàn),但是正因?yàn)樗δ茇S富,導(dǎo)致稍顯臃腫(二八定律:80%的時(shí)間里我們只會只用20%的功能),同時(shí)因?yàn)樗嬖谝远M(jìn)制格式保存、軟件不兼容、格式不兼容、難以進(jìn)行版本控制、難以實(shí)時(shí)分享預(yù)覽、難以多人協(xié)作等短板。而這恰恰是 GitBook + Markdown + Git 的長處。
簡單來說,GitBook + Markdown + Git 帶來的好處有:
- 語法簡單
- 兼容性強(qiáng)
- 導(dǎo)出方便
- 團(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)一步加工。
03. 怎么安裝GitBook
當(dāng)你聽了我的慫恿,并決定嘗試使用 GitBook 的時(shí)候,首先面臨的問題是 —— 如何搭建 GitBook 環(huán)境?
因?yàn)?GitBook 是基于 Node.js,所以我們首先需要安裝 Node.js(下載地址:https://nodejs.org/en/download/),找到對應(yīng)平臺的版本安裝即可。
現(xiàn)在安裝 Node.js 都會默認(rèn)安裝 npm(node 包管理工具),所以我們不用單獨(dú)安裝 npm,打開命令行,執(zhí)行以下命令安裝 GitBook:
sudo npm install gitbook-cli -g安裝完之后,就會多了一個 gitbook 命令(如果沒有,請確認(rèn)上面的命令是否加了 -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
想象一下,現(xiàn)在你準(zhǔn)備構(gòu)建一本書籍,你在硬盤上新建了一個叫 book的文件夾,按照以前的做法,你會新建一個 Word 文檔,寫上標(biāo)題,然后開始編輯內(nèi)容。但是現(xiàn)在有了 GitBook,你首先要做的是在 book文件夾下執(zhí)行以下命令:
gitbook init打開一個文件夾 book使用 gitbook init 初始化文件夾,會自動生成兩個必要的文件 README.md 和 SUMMARY.md
| README.md | 書的介紹文字,如前言、簡介,在章節(jié)中也可做為章節(jié)的簡介。 |
| SUMMARY.md | 定制書籍的章節(jié)結(jié)構(gòu)和順序。 |
編輯 SUMMARY.md 文件,內(nèi)容修改為
# Introduction# 目錄* [前言](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)在 book文件夾中再次執(zhí)行g(shù)itbook init命令。GitBook 會查找 SUMMARY.md 文件中描述的目錄和文件,如果沒有則會將其創(chuàng)建。
Typora 是所見即所得(實(shí)時(shí)渲染)的 Markdown 編輯器,這時(shí)候它是這樣的:
接著我們執(zhí)行 gitbook serve 來預(yù)覽這本書籍,執(zhí)行命令后會對 Markdown 格式的文檔進(jìn)行轉(zhuǎn)換,默認(rèn)轉(zhuǎn)換為 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
當(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 [書籍路徑] [輸出路徑]serve 命令也可以指定端口:
gitbook serve --port 10086生成 PDF 格式的電子書:
gitbook pdf ./ ./mybook.pdf生成 epub 格式的電子書:
gitbook epub ./ ./mybook.epub生成 mobi 格式的電子書:
gitbook mobi ./ ./mybook.mobi除此之外,可以用 Git 做版本管理。在 book 目錄下執(zhí)行 git init 初始化倉庫,執(zhí)行 git remote add 添加遠(yuǎn)程倉庫(你得先在遠(yuǎn)端建好)。接著就可以愉快地 commit,push,pull … 啦!
不是程序員的小伙伴可能不太喜歡用命令行,那其實(shí)版本管理這部分可以下載安裝 Git 或 GitHub 這些客戶端程序,在圖形界面上操作也是可以完成工作的。
05. 附錄
5.1 GitBook簡明教程
網(wǎng)址:https://blog.csdn.net/dengjin20104042056/article/details/107059577
5.2 GitBook官方參考手冊
下載:https://download.csdn.net/download/dengjin20104042056/12567114
總結(jié)
以上是生活随笔為你收集整理的【Tools】GitBook入门教程的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 【IT资讯】编程语言面临重新洗牌,这六种
- 下一篇: 【Tools】MarkDown教程(一)