跳轉到

Downstream docs stack recipe — 下游 docs 技術組合配方

Terminology rule (zh-TW pages)

技術名詞首次出現以「中文 (English original)」格式呈現，例：依賴注入 (dependency injection)。不自創翻譯——若無公認譯名直接保留英文 （如 embedding、tokenizer）。代碼、API 名、CLI flag、套件名、檔名一律不翻。

這頁現在由 mkdocs-site-bootstrap skill 維護。

完整配方在該 skill 的 reference 檔案： skills/local/mkdocs-site-bootstrap/references/docs-stack-recipe.md

該 skill 也綁了現成可複製的 template 給 mkdocs.yml、 pyproject.toml、GitHub Actions workflow，跟 docs 骨架 (skeleton) —— 詳見該 skill 的 assets/ 目錄。

快速開始 (Quick start)

如果你的 project 還沒用 mkdocs-site-bootstrap，套用同樣 docs 技術組合 的最簡單方式是在你的 repo 中調用該 skill：

# 在你 project 的 repo 根目錄
bash <path-to-agent-skills>/skills/local/mkdocs-site-bootstrap/scripts/init-docs-site.sh \
  --site-name "My Project" \
  --repo-slug owner/repo \
  --site-url https://owner.github.io/repo/

接著啟用 GitHub Pages 並觸發第一次部署 (deploy)：

bash <path-to-agent-skills>/skills/local/mkdocs-site-bootstrap/scripts/enable-pages.sh \
  --repo owner/repo

用 scaffold 產生的 strict helper 建立要部署的 artifact：

uv sync --extra docs
uv run python scripts/build-docs-site.py

保留 llmstxt 的多語站會把 root llms 檔限制在預設語言，並在另一個 strict pass 建立各 locale HTML。直接 mkdocs build --strict 仍是 HTML-only preview。

關於這個技術組合實際包含什麼 (Material theme + mkdocs-llmstxt + mkdocs-copy-to-llm + pymdownx.snippets)、strict mode 強制的連結規則、 以及 GitHub Actions workflow 的接線方式，請讀上面連結的 canonical reference。

既有使用者要注意：更新已安裝的 skill 不會自動遷移 project。若舊版 i18n 站點的 llms 輸出為空或語言錯誤，請使用 audit-first 的 migration guide。

另見 (See also)