Struct Markdown

pub struct Markdown { /* private fields */ }

Markdown parser and transformer.

Example

use note_mark::prelude::*;

let markdown = Markdown::default();

let html = markdown.execute("# Hello, world!\n\nThis is a paragraph.");

assert_eq!(html, "<h1>Hello, world!</h1><p>This is a paragraph.</p>");

Implementations

impl Markdown

pub fn new() -> Self

Create a new Markdown instance.

pub fn parser(self, parser: Parser) -> Self

Set the parser configuration.

pub fn transformer(self, transformer: Transformer) -> Self

Set the transformer configuration.

pub fn stringifier(self, stringifier: Stringifier) -> Self

Set the stringifier configuration.

pub fn toc_maker(self, toc_maker: TocMaker) -> Self

Set the table of contents maker configuration.

impl Markdown

pub fn execute(&self, input: &str) -> String

Execute the markdown parser.

pub fn execute_with_toc(&self, input: &str) -> (String, String)

Execute the markdown parser and generate the table of contents.

Example

use note_mark::prelude::*;

let markdown = Markdown::default();

let input = concat![
    "# Headline1-1\n\n",
    "# Headline1-2\n\n",
    "## Headline2-1\n\n",
    "## Headline2-2\n\n",
    "# Headline1-3\n\n",
];

let (html, toc) = markdown.execute_with_toc(input);

assert_eq!(toc, "<ul><li><a href=\"#Headline1-1\">Headline1-1</a></li><li><a href=\"#Headline1-2\">Headline1-2</a><ul><li><a href=\"#Headline2-1\">Headline2-1</a></li><li><a href=\"#Headline2-2\">Headline2-2</a></li></ul></li><li><a href=\"#Headline1-3\">Headline1-3</a></li></ul>");

Original output

<h1 id="Headline1-1">Headline1-1</h1>
<h1 id="Headline1-2">Headline1-2</h1>
<h2 id="Headline2-1">Headline2-1</h2>
<h2 id="Headline2-2">Headline2-2</h2>
<h1 id="Headline1-3">Headline1-3</h1>

Toc output

<ul>
    <li><a href="#Headline1-1">Headline1-1</a></li>
    <li>
        <a href="#Headline1-2">Headline1-2</a>
        <ul>
            <li><a href="#Headline2-1">Headline2-1</a></li>
            <li><a href="#Headline2-2">Headline2-2</a></li>
        </ul>
    </li>
    <li><a href="#Headline1-3">Headline1-3</a></li>
</ul>

Trait Implementations

impl Clone for Markdown

fn clone(&self) -> Markdown

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Markdown

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

Formats the value using the given formatter.

impl Default for Markdown

fn default() -> Markdown

Returns the “default value” for a type.