用 GitBook 建立一本書
Gitbook 首先是一個軟體,它使用 Git 和 Markdown 來編排書本,如果你沒有聽過 Git 和 Markdown,那麼 Gitbook 可能不适合你直接入手,你需要先去學習 Git 和 Markdown。Git 是一個版本控制工具,Markdown 是一個文本編輯文法,基本的使用大概幾個小時就可以都學會了,并不複雜。
這是 Gitbook 項目首頁上對 Gitbook 的定義。
Modern book format and toolchain using Git and Markdown .
安裝 GitBook
首先需要安裝 nodejs,以便能夠使用 npm 來安裝 gitbook
$ wget -qO- https://raw.github.com/creationix/nvm/v0.33.11/install.sh | sh
該指令會安裝 nvm 指令,安裝好以後會添加 nvm 的環境變量到
.bashrc
檔案裡,接下來退出終端,重新登陸使得
.bashrc
檔案生效,或者使用其他方法使添加的環境變量生效。
接下來使用下列指令來安裝 npm
$ nvm install stable
可以使用下列指令來檢視 npm 的版本,比如我這次安裝的是 6.11.3 版本。
[erdong@testhost ~]$ npm --version
6.11.3
[erdong@testhost ~]$
接下來使用 npm 來安裝 gitbook
$ npm install gitbook-cli -g
建立第一本書
首先建立一個目錄,這個目錄就是這本書的一個載體,就好比在現實世界裡你要先準備一個本子,以後所有的内容會寫在這個本子上。在 gitbook,我們以後所有的内容都會存放在這個目錄裡。
$ mkdir erdong-first-book
接下來我們初始化這個目錄,就好比你在你準備的本子上做一些基本的工作,
[erdong@testhost ~]$ cd erdong-first-book
[erdong@testhost erdong-first-book]$ gitbook init
[erdong@testhost erdong-first-book]$ ls
README.md SUMMARY.md
初始化過後,在這個檔案夾會生成 2 個檔案,
README.md
和
SUMMARY.md
。
- README.md : 是書的簡單介紹,類似于一本書的序或者前言部分。
- SUMMARY.md : 是書的目錄,程式按照這個檔案來生成書的結構。
初始化結束後,就可以寫東西了,
比如我們現在往這兩個檔案裡寫入以下内容,在 README.md 檔案中我們寫入如下内容:
# Introduction
This erdong's first book
This a samples in GitHub, https://github.com/erdong/gitbook-notes-samples
在 SUMMARY.md 檔案中寫入如下内容:
# Summary
* [Introduction](README.md)
* [Part I]()
* [Part II]()
* [Part III]()
寫入内容後,我們可以通過
gitbook serve
指令來預覽我們寫的書
[erdong@testhost erdong-first-book]$ 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 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.5s !
Starting server ...
Serving book on http://localhost:4000
這樣會在前台運作一個 web 程式,對外以 4000 端口提供一個可以浏覽的頁面,浏覽的位址是
http://localhost:4000,
這樣我們就可以檢視我們寫好的書了。如下圖所示。
如果我們不想使用這種方式來預覽書籍的話,也可以用 gitbook 生成一份靜态的頁面,放在 web 伺服器或者其他可以提供 web 浏覽通路的地方。生成靜态頁面使用
gitbook build
指令即可,會生成一個
_book
的檔案夾,這個目錄裡放的就是生成好的靜态頁面,拷貝到對應的目錄即可。
[erdong@testhost erdong-first-book]$ gitbook build
info: 7 plugins are installed
info: 6 explicitly listed
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 1 pages
info: found 0 asset files
info: >> generation finished with success in 0.5s !
[erdong@testhost erdong-first-book]$
小結
這樣,我們就通過 GitBook 工具寫了一本書,或者一個小冊子。