Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.1.4 — 2024-06-15

Added

Added help_markdown_custom() and help_markdown_command_custom(), for customizing the built Markdown using a new MarkdownOptions configuration structure. (#25, co-authored-by @morgante and @keturiosakys)

Supported customization options include:
- Contents of the command title header.
- Whether to show the footer explaining the documentation was generated with clap-markdown.
- Whether to show the command overview table of contents.
Added new CI build and test action to the repository, so that new PRs will be required automatically to pass all tests. (#24)

Changed

clap-markdown will now respect the Command.display_name property, if set, and use it in the rendered Markdown when showing the name and usage of the command. (#27, co-authored-by @keturiosakys and @hatchan)
The possible values of a flag that can only either be present or absent (true or false) will no longer be shown. (#22, contributed by @ilyagr)
Hidden arguments (Arg.hide == true) will no longer be included in the rendered Markdown. (#22, contributed by @ilyagr)
Long help text for commands will now be included in the rendered output. (#26, contributed by @morgante)
Long help text for options will now be included in the rendered output. (#23, contributed by @ilyagr)

0.1.3 - 2022-12-28

Added

For arguments that take a value, the argument value name (Arg::get_value_names()) is now included in the generated Markdown. (#11)
For arguments that have default values (Arg::get_default_values()) , those default values are mentioned in the generated Markdown. (#11)

Changed

The rendered Markdown for PossibleValue literal values now uses code styling instead of emphasized styling, for consistency with other literally-what-the-user-types help content (e.g. option or subcommand names). (#11)

0.1.2 - 2022-12-28

Added

Generated markdown for PossibleValue values will now include the PossibleValue::get_help() content, if it exists. (#8)

This means that documentation comments present on enum variants that use #[derive(clap::ValueEnum)] will be summarized in the generated Markdown documentation.

0.1.1 - 2022-12-26

Added

Added new basic example to README.md. (#4)
Added new 'Usage Convention: CommandLineHelp.md' section to README.md (#4)
Add list of projects using clap-markdown and CommandLineHelp.md convention to README.md. (#5)

0.1.0 - 2022-12-17

Added

Added new ./docs/examples/ directory to the repository, with Rust source code for the complex_app.rs example program, and the generated complex-app.md Markdown content for that program. (#1)

Changed

Modify generated Markdown. (#1)

The following changes are present in the generated Markdown:
- Added 'Command-Line Help for {name}' header
- Include Arg::get_possible_values() information in arguments and options documentation.
- Renamed 'Commands' label to 'Subcommands'
- Added small footer at the bottom stating that the document was generated automatically by clap-markdown.

0.0.1 - 2022-12-13

Initial release of clap-markdown.