6 个版本

0.1.4 2024年6月15日
0.1.3 2022年12月28日
0.0.1 2022年12月13日

#31开发工具

Download history 2442/week @ 2024-04-29 3977/week @ 2024-05-06 4091/week @ 2024-05-13 4293/week @ 2024-05-20 2486/week @ 2024-05-27 2385/week @ 2024-06-03 3380/week @ 2024-06-10 4187/week @ 2024-06-17 4881/week @ 2024-06-24 4953/week @ 2024-07-01 4283/week @ 2024-07-08 5622/week @ 2024-07-15 3615/week @ 2024-07-22 4377/week @ 2024-07-29 5954/week @ 2024-08-05 6148/week @ 2024-08-12

每月 20,461 次下载
48 Crates 中使用 (47 个直接使用)

MIT/Apache

24KB
355

clap-markdown

Crates.io License Documentation

API 文档 | 变更日志 | 贡献

自动为 clap 命令行工具生成 Markdown 文档。

示例

生成基本 clap 应用程序的 Markdown 文本

#[derive(clap::Parser)]
struct Cli {
    #[arg()]
    name: String,
}

let markdown: String = clap_markdown::help_markdown::<Cli>();

生成的 Markdown 示例

查看 clap 示例程序以及由 clap-markdown 生成的相应 Markdown

程序 Markdown
./complex_app.rs complex-app.md

使用约定:CommandLineHelp.md

本节描述了使用 clap-markdown 生成 CommandLineHelp.md 文件的建议约定,该文件可以提交到源代码控制,并作为在线文档查看。

  1. 将隐藏的 --markdown-help 选项添加到您的 clap 应用程序中
use clap::Parser;

#[derive(Parser)]
struct Cli {
    #[arg(long, hide = true)]
    markdown_help: bool,
}

fn main() {
    let args = Cli::parse();

    // Invoked as: `$ my-app --markdown-help`
    if args.markdown_help {
        clap_markdown::print_help_markdown::<Cli>();
    }
}
  1. 调用 --markdown-help 生成 CommandLineHelp.md 文件
$ cargo run -- --markdown-help > docs/CommandLineHelp.md
  1. CommandLineHelp.md 保存到 git 中,并从项目的 README.md 或其他相关文档中链接到它。

对于具有多个关联可执行文件的项目,请考虑使用命令名称作为后缀。例如:CommandLineHelp-your-app.mdCommandLineHelp-other-app.md

CommandLineHelp.md 提交到版本控制使跟踪命令行界面的用户可见更改变得容易。

使用 clap-markdown 的项目

以下项目使用 clap-markdown 生成 CommandLineHelp.md 参考文档

如需将项目添加到此列表,请提交一个issue。

与clap的兼容性

当此crate添加对clap的新MAJOR版本的支持时,clap-markdown的MAJOR版本号将进行更改。

兼容性历史

clap-markdown clap
v0.0.1 – v0.1.4 "4.*.*"

许可证

许可协议为以下之一

您可选择。

贡献

除非您明确说明,否则根据Apache-2.0许可证定义的,您有意提交给作品的所有贡献,都应按照上述方式双许可,不附加任何额外的条款或条件。

有关执行常见开发任务的说明,请参阅Development.md

有关维护此项目的说明,请参阅Maintenance.md

依赖项

~1MB
~15K SLoC