rustme

生成您的 Rust 项目的 README 类文件。

RustMe 通过将多个部分连接到一个新文件中生成文件。它具有对 Rust 项目有用的特定功能

• Rust 注释的 markdown 代码块会处理以移除以 # 开头的行，使得这些块在渲染时与使用 "...)] 时的效果相同。此包使用以下代码片段中的此功能。
• 从其他文件中包含代码片段。使用特殊注释标记文件，并导入它们。"基本"示例演示了此功能。
  • 代码片段会自动修剪，以移除每行开头的等宽空白。
• 包含远程 URL 的部分。
  • 我们管理许多仓库，并希望将所有仓库中 README 文件的特定部分标准化。此 README 的页脚是从另一个仓库加载的。
  • 这也可以用来包含标准文件。我们使用它来从中央仓库拉取标准文件，如许可证。

rustme 命令行界面

要安装，只需运行 cargo install rustme。

目前 rustme 忽略所有命令行参数。它查找位于 ./rustme.ron 或 ./.rustme/config.ron 的 Ron 格式化 配置，并相对于配置文件生成文件。

rustme 作为库

let config = rustme::Configuration::load("examples/basic/.rustme.ron").unwrap();
config.generate().unwrap();

这是一个 rustme

此 README 是使用 rustme 生成的。

开源许可证

本项目，就像来自 Khonsu Labs 的所有项目一样，是开源的。此存储库可在 MIT 许可证 或 Apache 许可证 2.0 下使用。

要了解更多关于贡献的信息，请参阅 CONTRIBUTING.md。