#cargo-toml #md #make #data #start #rust

已撤回 lmake_cargo_toml_to_md

将 Cargo.toml 数据包含到 md 中

2020.1209.1045 2021年8月14日
2020.1209.1044 2020年12月9日
0.5.5 2020年8月22日
0.5.4 2020年7月15日

#31 in #make

MIT 许可证

17KB
112

lmake_cargo_toml_to_md

🔴已废弃,🔴已弃用,🔴已停用!
它已被 crate cargo-auto 取代




将 Cargo.toml 数据包含到 md 中。
仓库;版本:2020.1209.1044 日期:2020-12-09 作者:Luciano Bestia

Lines in Rust code Lines in Doc comments Lines in Comments Lines in examples Lines in tests

Documentation crev reviews Lib.rs Licence

将 cargo.toml 数据包含到 md 文件中。
为了避免版本、作者和描述等数据不同步。
必须在包含 cargo.toml 文件的项目的根目录中执行 lmake_cargo_toml_to_md 二进制文件。
它仅适用于单个项目,不适用于工作区。

将 cargo.toml 数据包含到 md 文件中

在 md 文件中写入以下标记

1 [comment]: # (lmake_cargo_toml_to_md start)
2 [comment]: # (lmake_cargo_toml_to_md end)

lmake_cargo_toml_to_md 会删除标记之间的旧行
并包含日期和 cargo.toml 数据
版本、作者、仓库和描述。

Makefile.toml 中的任务

我使用 cargo make 来编写重复命令序列的脚本。
https://github.com/sagiegurari/cargo-make
Makefile.toml 中添加如下任务

[tasks.doc]
description = "create docs from doc comments"
clear = true
script = [
    "lmake_cargo_toml_to_md",
    "lmake_md_to_doc_comments",
    "cargo doc --no-deps --document-private-items",
    "\\rsync -avz --delete-after target/doc/*  docs/",
]

install

从 crates.io 安装
cargoinstall lmake_cargo_toml_to_md
然后您可以在每个 rust 项目文件夹中使用它。
执行实用工具不需要任何参数。

开发

文档
https://lucianobestia.github.io/lmake_cargo_toml_to_md/
为开发准备的 make 任务列表:构建、运行、文档、发布、...
cargomake

cargo crev reviews and advisory

建议始终使用 cargo-crev
来验证每个依赖项的可靠性。
请,传播此信息。
在网上使用此 URL 来阅读 crate 评论。例如
https://web.crev.dev/rust-reviews/crate/num-traits/

依赖项

~4–5.5MB
~79K SLoC