為本網站貢獻
本文件網站使用 mdBook 建置,並部署至 GitHub Pages。合併進 main 分支的變更會自動建置與部署。
既有頁面可直接從 GitHub 網頁介面編輯。若要建立新頁面,請同時更新 SUMMARY.md。完成變更後,建立 pull request 供審查。
若要進一步了解 mdBook 的運作方式,請參閱書籍的組成。本 repository 有一項不同之處,文件位於 repository 根目錄,而非 src/ 資料夾。
在本機開發
若要在本機建置網站,請 clone 此 repository 並安裝 mdbook,安裝方式見官方說明1。
安裝完成後,在此 repository 根目錄使用 mdbook 命令列工具。例如,下列指令會自動監看、建置並啟動網站。
mdbook serve
接著進行修改、在網頁瀏覽器中預覽,預設網址為 http://localhost:3000,再像其他 Git 專案一樣 commit、push 並建立 pull request。
-
另一種方式是從 GitHub releases 下載執行檔、解壓縮後放進此 repository 的
bin/,該目錄已列入.gitignore。之後在mdbook指令前加上路徑,例如bin/mdbook serve。 ↩