✒️ 文檔
Qob 包含全面的用戶指南。 請嘗試相應地擴展它您實施新功能。
該文檔使用 Hugo 和 GitHub Pages 以 Markdown 編寫。 前者是靜態站點生成器,後者是靜態網頁託管服務來自 GitHub。
💡 您可以在 docs/content/ 文件夾下找到我們所有的文檔。
要更改文檔,您應該:
- hugo 可執行; 靜態站點生成器。
要在本地設置網站,您需要先安裝主題:
# 克隆代碼庫和子模塊一起...
git clone https://github.com/cl-qob/cli --recurse-submodules
# 導航到 `docs/theme/geekdoc` 文件夾
cd ./docs/theme/geekdoc/
# 構建主題
npm install && npm run build
然後運行 hugo
命令:
# 導航回 `docs` 文件夾
cd ./docs/
# 在本地運行 hugo 服務器
hugo server
就是這樣! 現在您可以在瀏覽器裡面打開 localhost:1313
。 🎉
💡 如果你考慮寫草稿,你可以指定 -D 選項。