安裝GitBook
-
前提是已經安裝了node環境, 沒有安裝的需要先安裝node環境, 請另行參考文檔。
-
安裝完node之後， 最後給npm換淘寶源:
npm config set registry https://registry.npm.taobao.org/, 速度會快點。 -
通過
npm install gitbook-cli -g安裝GitBook。
使用GitBook
-
mkdir test_book && cd test_book創建一個目錄， 該目錄用於保存一本書的內容。 -
gitbook init初始化， 這時候會創建兩個文件:README.md和SUMMARY.md。
![在這裏插入圖片描述]()
-
使用命令
gitbook serve啓動服務， 瀏覽器輸入http://127.0.0.1:4000, 可以看到:
![在這裏插入圖片描述]()
-
使用
gitbook build ./ docs命令在當前目錄下生成一個docs文件夾，裏面保存的是一些html,css,js文件，這些文件對應剛剛看到的頁面內容。
使用Github託管頁面
- 新建一個項目， 填個倉庫名和描述就行了。
![在這裏插入圖片描述]()
- 創建成功後會跳轉到頁面， 如下
![在這裏插入圖片描述]()
- 在之前創建的
test_book文件夾中輸入命令git init初始化倉庫。 - 然後通過
git remote add origin [email protected]:ClassmateLin/test_book.git設置本地項目的遠程倉庫地址，這裏對應你實際的內容。 - 然後依次執行:
git add docs
git commit -m "測試書籍"
git push --set-upstream origin master
-
回到剛剛
Github完成項目創建的頁面進行刷新， 如圖:
![在這裏插入圖片描述]()
-
點擊
settings按鈕後跳轉至:
![在這裏插入圖片描述]()
-
然後往下來，找到
Github Pages:
![在這裏插入圖片描述]()
點擊第二個內容， 頁面會自動刷新。 -
再次回到
Github Pages：
-![在這裏插入圖片描述]()
畫橫線的部分就是訪問書籍的鏈接，效果:
寫文章發佈
上面沒有提到如何寫文章再發布， 這裏提下:
SUMMARY.md文件其作用是目錄定義, 如將其內容改爲:
# 目錄
* [介紹](README.md)
* [章節1](chap1.md)
* [章節2](chap2.md)
* [章節3](chap3.md)
-
然後依次在其同級目錄下創建:
chap1.md,chap2.md,chap3.md文件,README.md文件是原本存在的。- chap1.md內容:
章節1- chap2.md內容:
章節2- chap3.md內容:
章節3 -
寫完內容後需要重新生成頁面文件:
gitbook build ./ docs。 -
更新內容到
Github:git add .,git commit -m '更新',git push, 然後再訪問書籍頁面即可，會有一定延時。 -
Gitbook 支持多種插件， 可自行搜索相關教程進行添加, 示例效果可以看我這本RabbiMQ Python 入門教程。