Struct markdown::Options

pub struct Options {
    pub parse: ParseOptions,
    pub compile: CompileOptions,
}

Configuration that describes how to parse from markdown and compile to HTML.

In most cases, you will want to use the default trait or gfm method.

Examples

use markdown::Options;

// Use the default trait to compile markdown to HTML according to `CommonMark`:
let commonmark = Options::default();

// Use the `gfm` method to compile markdown to HTML according to GFM:
let gfm = Options::gfm();

Fields

parse: ParseOptions

Configuration that describes how to parse from markdown.

compile: CompileOptions

Configuration that describes how to compile to HTML.

Implementations

impl Options

pub fn gfm() -> Self

GFM.

GFM stands for GitHub flavored markdown. GFM extends CommonMark and adds support for autolink literals, footnotes, strikethrough, tables, and tasklists. On the compilation side, GFM turns on the GFM tag filter. The tagfilter is useless, but it’s included here for consistency.

For more information, see the GFM specification: https://github.github.com/gfm/

Trait Implementations

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.