目錄
一、gitbook簡介
GitBook是一個基於 Node.js 的命令行工具,可使用 Github/Git 和 Markdown 來製作精美的電子書,GitBook 並非關於 Git 的教程。
GitBook支持輸出多種文檔格式:
靜態站點:GitBook默認輸出該種格式,生成的靜態站點可直接託管搭載Github Pages服務上;
1·PDF:需要安裝gitbook-pdf依賴;
2·eBook:需要安裝ebook-convert;
3· 單HTML網頁:支持將內容輸出爲單頁的HTML,不過一般用在將電子書格式轉換爲PDF或eBook的中間過程;
4·JSON:一般用於電子書的調試或元數據提取。
使用GitBook製作電子書,必備兩個文件:README.md和SUMMARY.md。
二、gitbook安裝部署
由於gitbook是基於nodejs的工具,所以安裝gitbook前需先安裝nodejs。
1、安裝nodejs
# wget https://nodejs.org/dist/v10.9.0/node-v10.9.0-linux-x64.tar.xz // 下載
# tar xf node-v10.9.0-linux-x64.tar.xz // 解壓
# cd node-v10.9.0-linux-x64/ // 進入解壓目錄
# ./bin/node -v // 執行node命令 查看版本
v10.9.0
解壓文件的 bin 目錄底下包含了 node、npm 等命令,我們可以使用 ln 命令來設置軟連接:
ln -s /usr/software/node-v10.9.0-linux-x64/bin/npm /usr/local/bin/
ln -s /usr/software/node-v10.9.0-linux-x64/bin/node /usr/local/bin/
2、安裝gitbook
利用npm安裝gitbook,安裝步驟可見 Install GitBook。
npm install gitbook -g
npm install gitbook-cli -g
gitbook-cli 是構建book的工具,gitbook init時需要。
安裝後的gitbook會在node安裝bin目錄下,所以要使用gitbook目錄可以使用ln -s命令做好軟連接。
3、gitbook使用
gitbook 的基本用法非常簡單,基本上就只有兩步:
使用 gitbook init 初始化書籍目錄;
使用 gitbook serve 編譯書籍;
mkdir book
cd book
gitbook init
初始化後,book目錄內容如下:
book/
├── README.md
└── SUMMARY.md
README.md 和 SUMMARY.md 是兩個必須文件,README.md 是對書籍的簡單介紹:
# cat book/README.md
# Introduction
This is my first book.
SUMMARY.md 是書籍的目錄結構。內容如下:
# cat book/SUMMARY.md
# SUMMARY
* [Chapter1](chapter1/README.md)
* [Section1.1](chapter1/section1.1.md)
* [Section1.2](chapter1/section1.2.md)
* [Chapter2](chapter2/README.md)
書籍目錄結構創建完成以後,就可以使用 gitbook serve
來編譯和預覽書籍了。
# 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.4s !
Starting server ...
Serving book on http://localhost:4000
gitbook serve 命令實際上會首先調用 gitbook build 編譯書籍,然後啓動web服務,監聽在本地的 4000 端口。
用瀏覽器打開 http://127.0.0.1:4000 ,查看書籍的效果:
gitbook 爲我們創建了書籍目錄結構後,就可以向其中添加內容了,文件的編寫使用 markdown 語法,在文件修改過程中,每一次保存文件,gitbook serve
都會自動重新編譯,所以可以實時通過瀏覽器來查看最新的書籍效果!