Struct ExtensionOptions

Source

pub struct ExtensionOptions<'c> {Show 23 fields
    pub strikethrough: bool,
    pub tagfilter: bool,
    pub table: bool,
    pub autolink: bool,
    pub tasklist: bool,
    pub superscript: bool,
    pub header_ids: Option<String>,
    pub footnotes: bool,
    pub description_lists: bool,
    pub front_matter_delimiter: Option<String>,
    pub multiline_block_quotes: bool,
    pub alerts: bool,
    pub math_dollars: bool,
    pub math_code: bool,
    pub shortcodes: bool,
    pub wikilinks_title_after_pipe: bool,
    pub wikilinks_title_before_pipe: bool,
    pub underline: bool,
    pub subscript: bool,
    pub spoiler: bool,
    pub greentext: bool,
    pub image_url_rewriter: Option<Arc<dyn URLRewriter + 'c>>,
    pub link_url_rewriter: Option<Arc<dyn URLRewriter + 'c>>,
}

Expand description

Options to select extensions.

Fields§

§strikethrough: bool

Enables the strikethrough extension from the GFM spec.

let mut options = Options::default();
options.extension.strikethrough = true;
assert_eq!(markdown_to_html("Hello ~world~ there.\n", &options),
           "<p>Hello <del>world</del> there.</p>\n");

§tagfilter: bool

Enables the tagfilter extension from the GFM spec.

let mut options = Options::default();
options.extension.tagfilter = true;
options.render.unsafe_ = true;
assert_eq!(markdown_to_html("Hello <xmp>.\n\n<xmp>", &options),
           "<p>Hello &lt;xmp>.</p>\n&lt;xmp>\n");

§table: bool

Enables the table extension from the GFM spec.

let mut options = Options::default();
options.extension.table = true;
assert_eq!(markdown_to_html("| a | b |\n|---|---|\n| c | d |\n", &options),
           "<table>\n<thead>\n<tr>\n<th>a</th>\n<th>b</th>\n</tr>\n</thead>\n\
            <tbody>\n<tr>\n<td>c</td>\n<td>d</td>\n</tr>\n</tbody>\n</table>\n");

§autolink: bool

Enables the autolink extension from the GFM spec.

let mut options = Options::default();
options.extension.autolink = true;
assert_eq!(markdown_to_html("Hello www.github.com.\n", &options),
           "<p>Hello <a href=\"http://www.github.com\">www.github.com</a>.</p>\n");

§tasklist: bool

Enables the task list items extension from the GFM spec.

Note that the spec does not define the precise output, so only the bare essentials are rendered.

let mut options = Options::default();
options.extension.tasklist = true;
options.render.unsafe_ = true;
assert_eq!(markdown_to_html("* [x] Done\n* [ ] Not done\n", &options),
           "<ul>\n<li><input type=\"checkbox\" checked=\"\" disabled=\"\" /> Done</li>\n\
           <li><input type=\"checkbox\" disabled=\"\" /> Not done</li>\n</ul>\n");

§superscript: bool

Enables the superscript Comrak extension.

let mut options = Options::default();
options.extension.superscript = true;
assert_eq!(markdown_to_html("e = mc^2^.\n", &options),
           "<p>e = mc<sup>2</sup>.</p>\n");

§header_ids: Option<String>

Enables the header IDs Comrak extension.

let mut options = Options::default();
options.extension.header_ids = Some("user-content-".to_string());
assert_eq!(markdown_to_html("# README\n", &options),
           "<h1><a inert href=\"#readme\" aria-hidden=\"true\" class=\"anchor\" id=\"user-content-readme\"></a>README</h1>\n");

§footnotes: bool

Enables the footnotes extension per cmark-gfm.

For usage, see src/tests.rs. The extension is modelled after Kramdown.

let mut options = Options::default();
options.extension.footnotes = true;
assert_eq!(markdown_to_html("Hi[^x].\n\n[^x]: A greeting.\n", &options),
           "<p>Hi<sup class=\"footnote-ref\"><a href=\"#fn-x\" id=\"fnref-x\" data-footnote-ref>1</a></sup>.</p>\n<section class=\"footnotes\" data-footnotes>\n<ol>\n<li id=\"fn-x\">\n<p>A greeting. <a href=\"#fnref-x\" class=\"footnote-backref\" data-footnote-backref data-footnote-backref-idx=\"1\" aria-label=\"Back to reference 1\">↩</a></p>\n</li>\n</ol>\n</section>\n");

§description_lists: bool

Enables the description lists extension.

Each term must be defined in one paragraph, followed by a blank line, and then by the details. Details begins with a colon.

Not (yet) compatible with render.sourcepos.

First term

: Details for the **first term**

Second term

: Details for the **second term**

    More details in second paragraph.

let mut options = Options::default();
options.extension.description_lists = true;
assert_eq!(markdown_to_html("Term\n\n: Definition", &options),
           "<dl>\n<dt>Term</dt>\n<dd>\n<p>Definition</p>\n</dd>\n</dl>\n");

§front_matter_delimiter: Option<String>

Enables the front matter extension.

Front matter, which begins with the delimiter string at the beginning of the file and ends at the end of the next line that contains only the delimiter, is passed through unchanged in markdown output and omitted from HTML output.

---
layout: post
title: Formatting Markdown with Comrak
---

# Shorter Title

etc.

let mut options = Options::default();
options.extension.front_matter_delimiter = Some("---".to_owned());
assert_eq!(
    markdown_to_html("---\nlayout: post\n---\nText\n", &options),
    markdown_to_html("Text\n", &Options::default()));

use comrak::parse_document;
let mut options = Options::default();
options.extension.front_matter_delimiter = Some("---".to_owned());
let arena = Arena::new();
let input ="---\nlayout: post\n---\nText\n";
let root = parse_document(&arena, input, &options);
let mut buf = Vec::new();
format_commonmark(&root, &options, &mut buf);
assert_eq!(&String::from_utf8(buf).unwrap(), input);

§multiline_block_quotes: bool

Enables the multiline block quote extension.

Place >>> before and after text to make it into a block quote.

Paragraph one

>>>
Paragraph two

- one
- two
>>>

let mut options = Options::default();
options.extension.multiline_block_quotes = true;
assert_eq!(markdown_to_html(">>>\nparagraph\n>>>", &options),
           "<blockquote>\n<p>paragraph</p>\n</blockquote>\n");

§alerts: bool

Enables GitHub style alerts

> [!note]
> Something of note

let mut options = Options::default();
options.extension.alerts = true;
assert_eq!(markdown_to_html("> [!note]\n> Something of note", &options),
           "<div class=\"markdown-alert markdown-alert-note\">\n<p class=\"markdown-alert-title\">Note</p>\n<p>Something of note</p>\n</div>\n");

§math_dollars: bool

Enables math using dollar syntax.

Inline math $1 + 2$ and display math $$x + y$$

$$
x^2
$$

let mut options = Options::default();
options.extension.math_dollars = true;
assert_eq!(markdown_to_html("$1 + 2$ and $$x = y$$", &options),
           "<p><span data-math-style=\"inline\">1 + 2</span> and <span data-math-style=\"display\">x = y</span></p>\n");
assert_eq!(markdown_to_html("$$\nx^2\n$$\n", &options),
           "<p><span data-math-style=\"display\">\nx^2\n</span></p>\n");

§math_code: bool

Enables math using code syntax.

Inline math $`1 + 2`$

```math
x^2
```

let mut options = Options::default();
options.extension.math_code = true;
assert_eq!(markdown_to_html("$`1 + 2`$", &options),
           "<p><code data-math-style=\"inline\">1 + 2</code></p>\n");
assert_eq!(markdown_to_html("```math\nx^2\n```\n", &options),
           "<pre><code class=\"language-math\" data-math-style=\"display\">x^2\n</code></pre>\n");

§shortcodes: bool

Available on crate feature shortcodes only.

Phrases wrapped inside of ‘:’ blocks will be replaced with emojis.

let mut options = Options::default();
assert_eq!(markdown_to_html("Happy Friday! :smile:", &options),
           "<p>Happy Friday! :smile:</p>\n");

options.extension.shortcodes = true;
assert_eq!(markdown_to_html("Happy Friday! :smile:", &options),
           "<p>Happy Friday! 😄</p>\n");

§wikilinks_title_after_pipe: bool

Enables wikilinks using title after pipe syntax

[[url|link label]]

When both this option and wikilinks_title_before_pipe are enabled, this option takes precedence.

let mut options = Options::default();
options.extension.wikilinks_title_after_pipe = true;
assert_eq!(markdown_to_html("[[url|link label]]", &options),
           "<p><a href=\"url\" data-wikilink=\"true\">link label</a></p>\n");

§wikilinks_title_before_pipe: bool

Enables wikilinks using title before pipe syntax

[[link label|url]]

When both this option and wikilinks_title_after_pipe are enabled, wikilinks_title_after_pipe takes precedence.

let mut options = Options::default();
options.extension.wikilinks_title_before_pipe = true;
assert_eq!(markdown_to_html("[[link label|url]]", &options),
           "<p><a href=\"url\" data-wikilink=\"true\">link label</a></p>\n");

§underline: bool

Enables underlines using double underscores

__underlined text__

let mut options = Options::default();
options.extension.underline = true;

assert_eq!(markdown_to_html("__underlined text__", &options),
           "<p><u>underlined text</u></p>\n");

§subscript: bool

Enables subscript text using single tildes.

If the strikethrough option is also enabled, this overrides the single tilde case to output subscript text.

H~2~O

let mut options = Options::default();
options.extension.subscript = true;

assert_eq!(markdown_to_html("H~2~O", &options),
           "<p>H<sub>2</sub>O</p>\n");

§spoiler: bool

Enables spoilers using double vertical bars

Darth Vader is ||Luke's father||

let mut options = Options::default();
options.extension.spoiler = true;

assert_eq!(markdown_to_html("Darth Vader is ||Luke's father||", &options),
           "<p>Darth Vader is <span class=\"spoiler\">Luke's father</span></p>\n");

§greentext: bool

Requires at least one space after a > character to generate a blockquote, and restarts blockquote nesting across unique lines of input

>implying implications

> one
> > two
> three

let mut options = Options::default();
options.extension.greentext = true;

assert_eq!(markdown_to_html(">implying implications", &options),
           "<p>&gt;implying implications</p>\n");

assert_eq!(markdown_to_html("> one\n> > two\n> three", &options),
           concat!(
            "<blockquote>\n",
            "<p>one</p>\n",
            "<blockquote>\n<p>two</p>\n</blockquote>\n",
            "<p>three</p>\n",
            "</blockquote>\n"));

§image_url_rewriter: Option<Arc<dyn URLRewriter + 'c>>

Wraps embedded image URLs using a function or custom trait object.

let mut options = ComrakOptions::default();

options.extension.image_url_rewriter = Some(Arc::new(
    |url: &str| format!("https://safe.example.com?url={}", url)
));

assert_eq!(markdown_to_html("![](http://unsafe.example.com/bad.png)", &options),
           "<p><img src=\"https://safe.example.com?url=http://unsafe.example.com/bad.png\" alt=\"\" /></p>\n");

§link_url_rewriter: Option<Arc<dyn URLRewriter + 'c>>

Wraps link URLs using a function or custom trait object.

let mut options = ComrakOptions::default();

options.extension.link_url_rewriter = Some(Arc::new(
    |url: &str| format!("https://safe.example.com/norefer?url={}", url)
));

assert_eq!(markdown_to_html("[my link](http://unsafe.example.com/bad)", &options),
           "<p><a href=\"https://safe.example.com/norefer?url=http://unsafe.example.com/bad\">my link</a></p>\n");