工具選擇:Gitbook + GitHub Pages
大概流程:
首先在本地編寫md文件,然后生成對應的html文件,最后將這些html文件推送到github對應的gitbook倉庫。
具體步驟:
(一)本地gitbook安裝與初始化
-
在本地安裝 gitbook工具,詳細步驟網上很多,不贅述!
-
在本地創建一個目錄,切換至該目錄,執行
gitbook init
初始化;
然后,執行gitbook serve
可以通過訪問 localhost:4000 來預覽效果。 -
同樣在該目錄內,執行命令
gitbook build
,它會將相應的md文件轉為相應的html文件,就在 它創建的_book
目錄中。
(二)GitHub Pages配置
-
在github創建一個名為 gitbook的倉庫,同時在該倉庫創建
gh-pages
分支(將該gh-pages分支作為GitHub Pages的發布源)。 -
將本地
_book
目錄中的內容推送到 gitbook的倉庫的gh-pages
分支,然后我們便可以通過 https://userName.github.io/gitbook/ 來訪問我們的gitbook.
(三)日常編輯!!!<<==
- 使用 Gitbook Editor 或者 Typora 編輯md文檔。
- 執行命令
gitbook build
進行構建,然后推送到 gitbook的倉庫的gh-pages
分支。
(本人目前一般是 先構建至_book目錄,然后復制到本地的克隆倉庫目錄,再在倉庫目錄內進行推送)
相關拉取/推送命令:
將 github項目的 gh-pages分支 克隆到 本地的某目錄 如下:
git clone -b gh-pages https://github.com/zhongyuanzhao000/gitbook.git "D:Wiki\gh-pages"
使用 git clone 命令復制的項目需要 更新並推送時,
cd <project目錄>
git add * # 提交所有更改信息(刪除 增加文件)
git commit -m "update" # 提交更改文件的標簽
git push origin gh-pages # 推送到gh-pages分支