clap-markdown

API Documentation | Changelog | Contributing

Automatically generate Markdown documentation for clap command-line tools.

Examples

The ./docs/examples/ directory contains example clap applications, and their corresponding Markdown that is autogenerated by clap-markdown.

Examples:

| Program | Markdown | |------------------------------------------------------|--------------------------------------------------| | ./complex_app.rs | complex-app.md |

Compatibility with clap

When this crate adds support for a new MAJOR version of clap, the MAJOR version number of clap-markdown will be changed.

Compability History:

| clap-markdown | clap | |-----------------|-----------| | v0.0.1 | "4.*.*" |

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

See Development.md for instructions on how to perform common development tasks.

See Maintenance.md for instructions on how to maintain this project.