Enum MarkdownTemplate 

pub enum MarkdownTemplate {
    Spec,
    Index,
    Command,
    Argument,
    Flag,
    Config,
}

One of the templates used to generate Markdown documentation.

A renderer starts with a complete built-in template set. Replacing one member keeps the others available, including through Tera’s {% include %} directive. This lets an adopter change the document shell or the presentation of one kind of item without copying the whole theme.

Variants

Spec

A single-file document containing the root and every subcommand.

Index

The landing page generated in multi-file mode.

Command

A command and its arguments, flags, outputs, exits, and examples.

Argument

The details beneath one positional argument.

Flag

The details beneath one flag.

Config

The configuration reference appended to a spec or written in multi-file mode.

Trait Implementations

impl Clone for MarkdownTemplate

fn clone(&self) -> MarkdownTemplate

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for MarkdownTemplate

impl Debug for MarkdownTemplate

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for MarkdownTemplate

impl PartialEq for MarkdownTemplate

fn eq(&self, other: &MarkdownTemplate) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for MarkdownTemplate