Struct MarkdownOptions

#[non_exhaustive]
pub struct MarkdownOptions { /* private fields */ }

Options to customize the structure of the output Markdown document.

Used with help_markdown_custom().

Implementations

impl MarkdownOptions

pub fn new() -> Self

Construct a default instance of MarkdownOptions.

pub fn title(self, title: String) -> Self

Set a custom title to use in the generated document.

pub fn show_footer(self, show: bool) -> Self

Whether to show the default footer advertising clap-markdown.

pub fn show_table_of_contents(self, show: bool) -> Self

Whether to show the default table of contents.

Trait Implementations

impl Default for MarkdownOptions

fn default() -> Self

Returns the “default value” for a type.