#文档 #rustdoc #替换 #无 std

无 std include-utils

类似于 mdBook 的 include 宏,作为标准 include_str 宏的强大替代品

5 个版本

0.2.2 2024 年 4 月 19 日
0.2.1 2024 年 3 月 31 日
0.2.0 2024 年 1 月 12 日
0.1.1 2023 年 12 月 29 日
0.1.0 2023 年 12 月 29 日

#721 in 开发工具

Download history 12/week @ 2024-05-03 18/week @ 2024-05-10 42/week @ 2024-05-17 64/week @ 2024-05-24 34/week @ 2024-05-31 49/week @ 2024-06-07 61/week @ 2024-06-14 74/week @ 2024-06-21 39/week @ 2024-06-28 81/week @ 2024-07-05 209/week @ 2024-07-12 101/week @ 2024-07-19 131/week @ 2024-07-26 98/week @ 2024-08-02 107/week @ 2024-08-09 92/week @ 2024-08-16

每月 436 次下载
用于 3 crate

MIT/Apache

9KB

Include utils

tests crates.io Documentation MIT/Apache-2 licensed

标准 inlcude_str 宏的更强大替代品。

通常你只需要文件的一部分,例如示例的相关行或 README.md 的某个部分。此 crate 提供了可以包含文件一部分的宏,类似于 mdbook 特定功能。

想象一下,你想将仓库的 README 文件中的 "用法" 部分包含到 crate 文档中。但你不想在 crate 文档中看到 README 文件的一些部分,如标题、徽章等。使用 include_str 宏,你只能包含整个文件内容。

但使用 include_md 宏,你只能包含文件的一部分。

注意事项

  • 与内置宏不同,此宏使用 CARGO_MANIFEST_DIR 作为当前目录,而不是调用宏的目录。

  • 如果启用了 workspace 功能,那么如果文件相对于 CARGO_MANIFEST_DIR 无法找到,它将相对于 cargo 工作区根目录进行搜索。如果你想在单个目录中存储你的文档(位于 crate 之外),这可能很有用。在这种情况下,你必须在将 crate 发布到 crate 注册表之前,将包含的目录复制到每个 crate 中。

用法

//! # Crate overview
//!
#![doc = include_utils::include_md!("README.md:description")]
//!
//! ## Other section

依赖项

~1–1.6MB
~32K SLoC