rust-lang/rust-forge 来源：https://github.com/rust-lang/rust-forge

Rust Forge

欢迎来到 Rust Forge！Rust Forge 是一个补充文档库，专为 Rust 编程语言 的社区成员提供有用的参考资料。

开发

你可以通过安装 mdbook 并运行以下命令来构建本地版本。

mdbook build

这会自动构建并运行 blacksmith 工具。在开发时，建议使用 serve 命令启动本地服务器，以便轻松查看和更新所做的更改。

mdbook serve

链接检查

在 CI 中，我们会自动检查 Forge Markdown 文件中的所有文档内链接是否有效。如果你想在本地执行此检查，请使用 cargo install [email protected] --locked 安装 mdbook-linkcheck2，然后直接运行 mdbook build 或 mdbook serve。

Blacksmith

Blacksmith 是一个可在构建 Forge 之前运行的工具。它会下载关于 Rust 版本的信息，用于渲染包含历史 Rust 版本的页面。由于编译和运行需要一些时间，它默认是禁用的。要启用它，请运行 mdbook serve 或 mdbook build，并设置环境变量 RUN_BLACKSMITH=1。

JavaScript

Forge 使用 JavaScript 来显示版本的日期以及“无工具损坏周”。修改 JavaScript 时，请确保符合 standard 风格。你可以使用以下命令安装 standard 并自动格式化代码。

安装命令

# 使用 Yarn
yarn global add standard

# 使用 NPM
npm install --global standard

格式化

standard --fix js/

贡献

添加团队

任何 Rust 团队、工作组或项目组都可以在 Rust Forge 中拥有一个章节。首先，请发送 PR 将你的团队添加到 repos/rust-lang/rust-forge.toml 文件中，以赋予你的团队权限。

要将团队添加到本书中，请将其添加到 src/SUMMARY.md，如下所示。将 <team> 替换为你的团队名称的文件系统和 URL 友好版本：

- [<team>](src/<team>/index.md)

如果你运行 mdbook build，mdbook 会自动为你的团队创建文件夹和文件。建议将通用的团队信息放在 src/<team>/index.md 中，例如会议时间、团队管理的仓库、聊天平台链接等。较大的主题应作为子页面，例如 src/release/topic.md：

- [主题](src/<team>/主题.md)

团队负责合并自己的内容。请将你的团队添加到 triagebot.toml 的 [assign.owners] 部分，这样机器人会自动将相关任务分配给团队成员。

Rust Forge 的维护

Rust 基础设施团队 负责维护 Rust Forge，确保其构建和发布系统正常运行，并与各团队协调解决任何技术问题。