說明
參考
為什麼不用 Wiki ?
在我的理解中 Wiki 是該專案的說明文件, 而我要寫文件又是關於在該專案中開發遇到問題以及經驗
操作演示
提示: 建議在操作前先備份專案檔案
在現有專案上建立 docs 空白分支
- 建立分支
git checkout --orphan docs- 移除在版本控制的檔案
git rm --cached -r .
git clean -f -d- 新增忽略檔案
如果發現專案中還在檔案及資料夾, 可以新增忽略檔案來處理
建立 .gitignore 資料夾, 並且寫入以下內容
*
!.gitignore
!/docsdocs是要編寫文件目錄
為什麼不放在最外層? 考慮到專案根目錄可能還存在其他沒有加入版本控制的檔案, 導致目錄混亂不好管理
使用 gitbook
具體安裝和使用, 可以看參考中連結
- 初始化
cd docs
gitbook init- 生成
__book
gitbook build使用 git subtree 提交 _book 資料夾
git subtree push --prefix=_book origin gh-pages- 重複提交更新
gh-pages
git subtree split --rejoin --prefix=docs/_book --branch gh-pages
git push origin gh-pages:gh-pages本作品採用《CC 協議》，轉載必須註明作者和本文連結