一、簡介
GitBook 是一個基於 Node.js 的命令列工具,可使用 Github/Git 和 Markdown 來製作精美的電子書,
支援輸出多種文件格式:
- 靜態站點:GitBook 預設輸出該種格式,生成的靜態站點可直接託管搭建 Github Pages 服務上;
- PDF:需要安裝 gitbook-pdf 依賴;
- eBook:需要安裝 ebook-convert;
- 單HTML網頁:支援將內容輸出為單頁的HTML,不過一般用在將電子書格式轉換為PDF或eBook的中間過程;
- JSON:一般用於電子書的除錯或元資料提取;
使用 GitBook 製作電子書,必備兩個檔案:*README.md* 和 *SUMMARY.md*
二、GitBook 準備工作2.1 系統環境
需要準備一臺CentOS7.5 x86_64系統環境,用於部署gitbook伺服器端程式,用於在本地檢視gitbook編輯儲存的內容。
2.2 修改yum源
shell> wget -O /etc/yum.repos.d/CentOS-Base.repo http://mirrors.aliyun.com/repo/Centos-7.reposhell> wget -O /etc/yum.repos.d/epel.repo http://mirrors.aliyun.com/repo/epel-7.reposhell> yum clean allshell> yum makecache
2.3 安裝 Node.js 和 npm
GitBook 是一個基於 Node.js 的命令列工具,下載安裝 Node.js,安裝完成之後,你可以使用下面的命令來檢驗是否安裝成功。
shell> yum -y install nodejs npmshell> node -vv6.17.1shell> npm -v3.10.10# 由於不可說的原因,npm install 時速度總是非常慢,用如下方式修改npm源shell> npm config set registry https://registry.npm.taobao.org# 檢視修改結果shell> npm config get registry
2.4 安裝 GitBook
shell> npm install gitbook-cli -g# 驗證安裝結果shell> gitbook -VCLI version: 2.3.2Installing GitBook 3.2.3三、建立 Gitbook 賬號與配置
3.1 建立GitBook賬號的過程這裡不再說明,根據官方註冊內容填寫。註冊網址:https://app.gitbook.com/join
3.2 登入GitBook頁面 https://app.gitbook.com/login
3.3 建立一個專案
3.4 專案初始介面,這個時候我們就可以在介面右側進行內容編寫了。
3.5 設定GitBook to GitHub功能支援
點選左側"盒子"的圖示,然後啟用"GitHub",根據彈出的介面配置GitHub的同步地址,配置完成後,在GitBook上儲存的內容,會自動同步到GitHub上。
四、Linux環境配置(作為Client端撰寫Markdown文件時配置)4.1 初始化
建立一個資料夾,使用 gitbook init 對其初始化,會自動生成兩個必要的檔案 *README.md* 和 *SUMMARY.md*
shell> mkdir /home/gitbook/shell> cd /home/gitbook/shell> gitbook initwarn: no summary file in this book info: create README.md info: create SUMMARY.md info: initialization is finished- README.md:書的介紹文字,如前言、簡介,在章節中也可做為章節的簡介。
- SUMMARY.md 定製書籍的章節結構和順序。
4.2 啟動服務
預設Web介面埠4000shell> gitbook serve /home/gitbook/Live reload server started on port: 35729Press 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.6s ! Starting server ...Serving book on http://localhost:40004.3 用瀏覽器訪問 http://localhost:4000 預覽電子書效果
4.4 注意事項
由於在每次重啟 gitbook 服務的時候,_book 目錄下的檔案都會被清空,為避免資料的丟失應將md檔案轉換為html檔案,放在nginx下訪問,這樣也就不用啟動gitbook服務了。