Struct mdxt::RenderOption

pub struct RenderOption {
    pub link_handler: fn(_: &str) -> String,
    pub header_anchor: bool,
    pub parse_metadata: bool,
    pub javascript: bool,
    pub class_prefix: String,
    pub xml: bool,
}

Fields

link_handler: fn(_: &str) -> String

when rendering [Lable](Link) to html, Link goes through this function. The link first goes through the default handler then the given function. If you don’t give any function, it’ll only go through the default handler. The default handler does two things

• reject links with invalid characters
• normalize anchors
• make alphabets lowercase
• replace whitespaces with dashes

header_anchor: bool

give id attributes to header tags

parse_metadata: bool

javascript: bool

Javascript is required to render collapsible tables and math formulas. If this option is true, the engine will add javascript codes when needed. If you want to use your own script, turn this option off.

class_prefix: String

It prefixes all the html classes.

xml: bool

If you want the output to be a well-formed xml, turn it on. It’s not a polyglot markup, though.

Implementations

impl RenderOption

pub fn set_link_handler(
    &mut self,
    link_handler: fn(_: &str) -> String
) -> &mut Self

pub fn set_header_anchor(&mut self, header_anchor: bool) -> &mut Self

pub fn set_class_prefix(&mut self, class_prefix: String) -> &mut Self

pub fn set_xml(&mut self, xml: bool) -> &mut Self

pub fn enable_metadata(&mut self, parse_metadata: bool) -> &mut Self

pub fn enable_javascript(&mut self, javascript: bool) -> &mut Self

pub fn handle_link(&self, link: &str) -> String

it’s used internally by the engine

Trait Implementations

impl Clone for RenderOption

fn clone(&self) -> RenderOption

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RenderOption

fn default() -> Self

Returns the “default value” for a type.