GitBook是一個簡單的個人線上書籍網站,在這裡可以把自己的文檔整理成書籍釋出出來,便于閱讀,現在使用gitee+gitbook搭建個人線上電子書!
官方示例:https://blog.gitbook.com/
搭建環境
git
node.js
gitbook
Gitee Pages
搭建步驟
- 配置好本地Git環境
- 安裝node.js,可在cmd輸入node檢視是否安裝成功
- 使用碼雲Gitee(與Github類似),建立倉庫,開啟Gitee Pages服務,
master分支放HTML檔案,建立book分支放源碼
- gitbook 環境搭建
1.安裝gitbook
npm install -g gitbook-cli
gitbook -V
2.建立目錄
mkdir gitbook
cd gitbook
gitbook init
3.啟動gitbook服務,可以在浏覽器檢視
gitbook serve
4.生成項目靜态網頁,"_book"目錄
gitbook build
5.安裝gitbook插件
gitbook install
6.成 PDF 格式的電子書
gitbook pdf ./ ./mybook.pdf
使用報錯
gitbook -V安裝報錯
C:\Users\Admin\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js:287
if (cb) cb.apply(this, arguments)
^
TypeError: cb.apply is not a function
解決方案
注釋C:\Users\Admin\AppData\Roaming\npm\node_modules\gitbook-cli\node_modules\npm\node_modules\graceful-fs\polyfills.js
// fs.stat = statFix(fs.stat)
// fs.fstat = statFix(fs.fstat)
// fs.lstat = statFix(fs.lstat)
Gitbook結構介紹
# gitbook init後生成檔案樹
├── node_modules
├── book.json (配置資料 (optional))
├── README.md (電子書的前言或簡介 (required))
├── SUMMARY.md (電子書目錄 (optional))
├── GLOSSARY.md (詞彙/注釋術語清單 (optional))
優化Gitbook
在gitbook中有很多有用的插件,可以進行美化頁面,但是使用起來會有一點麻煩,這裡僅講解如何使用,gitbook的插件大部分都在npm上,可以通路npm官網自行檢視并搜尋插件。
npm官網:https://www.npmjs.com/
示範安裝gitbook-plugin-summary的方法
插件:gitbook-plugin-summary (自動生成目錄)
安裝步驟:
1.打開gitbook根檔案夾下的book.json檔案,若沒有就建立此檔案
2.将以下代碼複制進去
{
"plugins": ["summary"]
}
3.打開指令行,在這個檔案夾中執行指令`gitbook install`安裝插件,執行指令`gitbook serve`,
然後在檢視的時候就會發現,之前明明沒有寫目錄,現在卻有了目錄
由于配置檔案是json格式,格式要求嚴格,若格式出現錯誤則會報錯,是以提供一個json格式化校驗的網站https://www.bejson.com/