Skip to main content

Crate foundry_cli_markdown

Crate foundry_cli_markdown 

Source
Expand description

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)

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 ๐Ÿ”’