Crate foundry_cli_markdown 

Generate Markdown documentation for clap command-line tools.

This is a fork of clap-markdown with the following enhancements:

• Support for grouped options by help heading (PR #48)
• Show environment variable names for arguments (PR #50)
• Add version information to generated Markdown (PR #52)

Re-exports

pub(crate) use collections::BTreeMap; 🔒

pub(crate) use self; 🔒

pub(crate) use Write; 🔒

pub(crate) use clap::builder::PossibleValue; 🔒

Structs

MarkdownOptions

Options to customize the structure of the output Markdown document.

Functions

build_command_markdown 🔒

build_table_of_contents_markdown 🔒

get_alias_string 🔒

get_canonical_name 🔒

Utility function to get the canonical name of a command.

help_markdown

Format the help information for command as Markdown.

help_markdown_command

Format the help information for command as Markdown.

help_markdown_command_custom

Format the help information for command as Markdown, with custom options.

help_markdown_custom

Format the help information for command as Markdown, with custom options.

indent 🔒

Indents non-empty lines. The output always ends with a newline.

pluralize 🔒

print_help_markdown

Format the help information for command as Markdown and print it.

write_arg_markdown 🔒

write_help_markdown 🔒