跳至主要内容

GitHub Pages

TinyLoop wiki 以開源 Docusaurus classic 範本建置，已設定可在 GitHub Pages 上乾淨發布。

本機建置​

cd wiki
npm ci
npm run build

靜態輸出位於 wiki/build。

部署工作流​

倉庫內有專用 workflow：.github/workflows/wiki.yml。

該 workflow 會：

  1. 安裝 Node 22
  2. 依 wiki/package-lock.json 還原 npm cache
  3. 從 wiki/ 建置站點
  4. 上傳產生的 Pages artifact
  5. 部署到 GitHub Pages 環境

Base URL 處理​

Docusaurus 設定會在可用時，從 GitHub 環境變數推導 owner、repository 與 base path。

因此同一份原始碼可同時支援：

  • 使用者或組織型 Pages 站點
  • 位於 /<repo>/ 的專案型 Pages 站點

不需要為不同部署目標反覆手動改設定。

需要提交的內容​

請提交：

  • wiki/ 原始檔
  • wiki/package-lock.json
  • .github/workflows/wiki.yml

請勿提交：

  • wiki/node_modules/
  • wiki/build/

Pages 設定​

在倉庫設定中，將 GitHub Pages 的建置與部署來源設為 GitHub Actions。