GitHub Pages(静态站点托管)

本仓库使用 mdBook(文档构建工具) 和 GitHub Pages(静态站点托管) 发布手册。

每种语言的手册都是独立的 mdBook(文档构建工具) 项目。每种语言都有自己的 SUMMARY.md，因此左侧目录只显示当前语言的页面：

manual/
  en/
    book.toml
    SUMMARY.md
    introduction.md
    quick-start.md
    ...
  zh/
    book.toml
    SUMMARY.md
    introduction.md
    quick-start.md
    ...
  ja/
    book.toml
    SUMMARY.md
    introduction.md
    quick-start.md
    ...
  ko/
  fr/
  de/
  es/
  pt/
  sv/
  fi/
  nl/

本地构建：

scripts/publish-pages.sh

生成站点写入：

target/mdbook

发布 Workflow(工作流)

.github/workflows/pages.yml 中的 workflow(工作流) 会在 push(推送) 到 main 时运行，也支持手动触发。它会执行以下步骤：

它会 checkout(检出) 仓库。
它会安装 mdBook(文档构建工具)。
运行 scripts/publish-pages.sh。
它会将 target/mdbook 上传为 Pages artifact(页面产物)。
它会将 artifact(产物) 部署到 GitHub Pages(静态站点托管)。

发布 URL：

https://developerworks.github.io/rust-config-tree/

Crate 发布

下面的命令会执行完整的提交、推送、Pages(静态页面) 部署和 crate(软件包) 发布流程：

scripts/release.sh --execute --message "Release 0.1.3"

在仓库根目录可以使用 crate(软件包) 发布辅助脚本：

scripts/publish-crate.sh

默认模式会运行检查和 cargo publish --dry-run。如果当前版本已经存在于 crates.io，脚本会自动 bump patch(递增补丁版本号)。检查通过后，可以发布到 crates.io：

scripts/publish-crate.sh --execute

脚本用法汇总在 scripts/README.md。

Keyboard shortcuts

rust-config-tree 手册

GitHub Pages(静态站点托管)

发布 Workflow(工作流)

Crate 发布