Struct comrak::ComrakExtensionOptions
source · [−]pub struct ComrakExtensionOptions {
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>,
}
Expand description
Options to select extensions.
Fields
strikethrough: bool
Enables the strikethrough extension from the GFM spec.
let mut options = ComrakOptions::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 = ComrakOptions::default();
options.extension.tagfilter = true;
options.render.unsafe_ = true;
assert_eq!(markdown_to_html("Hello <xmp>.\n\n<xmp>", &options),
"<p>Hello <xmp>.</p>\n<xmp>\n");
table: bool
Enables the table extension from the GFM spec.
let mut options = ComrakOptions::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 = ComrakOptions::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 = ComrakOptions::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\" disabled=\"\" checked=\"\" /> Done</li>\n\
<li><input type=\"checkbox\" disabled=\"\" /> Not done</li>\n</ul>\n");
superscript: bool
Enables the superscript Comrak extension.
let mut options = ComrakOptions::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 = ComrakOptions::default();
options.extension.header_ids = Some("user-content-".to_string());
assert_eq!(markdown_to_html("# README\n", &options),
"<h1><a 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 = ComrakOptions::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=\"#fn1\" id=\"fnref1\">1</a></sup>.</p>\n<section class=\"footnotes\">\n<ol>\n<li id=\"fn1\">\n<p>A greeting. <a href=\"#fnref1\" class=\"footnote-backref\">↩</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.
First term
: Details for the **first term**
Second term
: Details for the **second term**
More details in second paragraph.
let mut options = ComrakOptions::default();
options.extension.description_lists = true;
assert_eq!(markdown_to_html("Term\n\n: Definition", &options),
"<dl><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
---
etc.
let mut options = ComrakOptions::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", &ComrakOptions::default()));
use comrak::parse_document;
let mut options = ComrakOptions::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);
Trait Implementations
sourceimpl Clone for ComrakExtensionOptions
impl Clone for ComrakExtensionOptions
sourcefn clone(&self) -> ComrakExtensionOptions
fn clone(&self) -> ComrakExtensionOptions
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for ComrakExtensionOptions
impl Debug for ComrakExtensionOptions
sourceimpl Default for ComrakExtensionOptions
impl Default for ComrakExtensionOptions
sourcefn default() -> ComrakExtensionOptions
fn default() -> ComrakExtensionOptions
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl RefUnwindSafe for ComrakExtensionOptions
impl Send for ComrakExtensionOptions
impl Sync for ComrakExtensionOptions
impl Unpin for ComrakExtensionOptions
impl UnwindSafe for ComrakExtensionOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more