Struct MdFormatter

pub struct MdFormatter {
    man_map: ManMap,
}

Fields

man_map: ManMap

Implementations

impl MdFormatter

pub fn new(man_map: ManMap) -> MdFormatter

impl MdFormatter

fn render_html(&self, input: &str) -> Result<String, Error>

Trait Implementations

impl Formatter for MdFormatter

fn render(&self, input: &str) -> Result<String, Error>

Renders the given markdown to the formatter’s output.

fn render_options_start(&self) -> &'static str

Renders the start of a block of options (triggered by {{#options}}).

fn render_options_end(&self) -> &'static str

Renders the end of a block of options (triggered by {{/options}}).

fn render_option( &self, params: &[&str], block: &str, man_name: &str, ) -> Result<String, Error>

Renders an option (triggered by {{#option}}).

fn linkify_man_to_md(&self, name: &str, section: u8) -> Result<String, Error>

Converts a man page reference into markdown that is appropriate for this format.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes