Docusaurus 跨 Repo 部署到 GitHub Pages:從零到自動化的五個坑
· 閱讀時間約 3 分鐘
用 Docusaurus 建官方網站很快,但把它接上 GitHub Pages 的自動部署,尤其是「source repo 與 Pages repo 分開」的架構,踩了不少坑。這篇把整個過程與解法記下來,下次不用再查。
Docusaurus / 靜態站台
檢視所有標籤用 Docusaurus 建官方網站很快,但把它接上 GitHub Pages 的自動部署,尤其是「source repo 與 Pages repo 分開」的架構,踩了不少坑。這篇把整個過程與解法記下來,下次不用再查。
當你需要說明重點提示、互動範例或分頁程式碼等更豐富的敘事方式時,可以在 Markdown 中混用 React 元件;而一般文字仍維持純 Markdown,兼顧易寫與彈性。
讓 MDX 區塊維持精簡(建議 40 行內),並替所有媒體提供描述性的 alt 文字,方便後續翻譯與在地化。
npm install。npm run start 在本機確認頁面載入正常。Props 型別,方便其他作者複用。@site/src/components/ 匯入。<Tabs groupId="language">
<TabItem value="checklist" label="CLI 檢查清單">
1. 下載最新範本並執行 `npm install`。
2. 透過 `npm run start` 在本機確認頁面載入正常。
3. 將遇到的錯誤與重現步驟加到 issue 描述中。
</TabItem>
<TabItem value="notes" label="TypeScript 筆記">
- 先在 Markdown 定義所有可翻譯字串,再用 props 傳入 React 元件。
- 為 MDX 互動元件設計 `Props` 型別,方便其他作者複用。
- 若多篇文章都用到相同邏輯,可移到 `@site/src/components/` 匯入。
</TabItem>
</Tabs>
Tabs 與 TabItem 能在同一區塊切換語言或平台CodeBlock 方便加上區塊標題或切成 live editorAdmonition 與 Details 可凸顯警示或折疊補充說明