ferromark 0.7.0

Ultra-high-performance Markdown to HTML compiler
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

use ferromark::{Options, to_html_with_options};

fn subscript_html(input: &str) -> String {
    to_html_with_options(
        input,
        &Options {
            subscript: true,
            heading_ids: false,
            ..Options::default()
        },
    )
}

fn no_subscript_html(input: &str) -> String {
    to_html_with_options(
        input,
        &Options {
            subscript: false,
            heading_ids: false,
            ..Options::default()
        },
    )
}

#[test]
fn basic_subscript() {
    assert_eq!(subscript_html("H~2~O"), "<p>H<sub>2</sub>O</p>\n");
}

#[test]
fn subscript_in_paragraph() {
    assert_eq!(
        subscript_html("before ~sub~ after"),
        "<p>before <sub>sub</sub> after</p>\n"
    );
}

#[test]
fn subscript_with_emphasis_inside() {
    assert_eq!(
        subscript_html("~**bold**~"),
        "<p><sub><strong>bold</strong></sub></p>\n"
    );
}

#[test]
fn subscript_disabled() {
    assert_eq!(no_subscript_html("H~2~O"), "<p>H~2~O</p>\n");
}

#[test]
fn subscript_does_not_parse_as_strikethrough() {
    assert_eq!(no_subscript_html("~sub~"), "<p>~sub~</p>\n");
}

#[test]
fn unmatched_subscript_is_literal() {
    assert_eq!(subscript_html("~sub"), "<p>~sub</p>\n");
    assert_eq!(subscript_html("sub~"), "<p>sub~</p>\n");
}

#[test]
fn empty_subscript_is_literal() {
    assert_eq!(subscript_html("~~"), "<p>~~</p>\n");
}

#[test]
fn whitespace_only_subscript_is_literal() {
    assert_eq!(subscript_html("~  ~"), "<p>~  ~</p>\n");
}

#[test]
fn code_span_wins_over_subscript() {
    assert_eq!(subscript_html("`~x~`"), "<p><code>~x~</code></p>\n");
}

#[test]
fn links_work_inside_subscript() {
    assert_eq!(
        subscript_html("~[link](https://example.com)~"),
        "<p><sub><a href=\"https://example.com\">link</a></sub></p>\n"
    );
}

#[test]
fn subscript_works_inside_link_text() {
    assert_eq!(
        subscript_html("[~x~](https://example.com)"),
        "<p><a href=\"https://example.com\"><sub>x</sub></a></p>\n"
    );
}

#[test]
fn subscript_does_not_parse_in_link_destinations() {
    assert_eq!(
        subscript_html("[link](https://example.com/~x~)"),
        "<p><a href=\"https://example.com/~x~\">link</a></p>\n"
    );
}

#[test]
fn subscript_and_strikethrough_coexist() {
    assert_eq!(
        subscript_html("H~2~O and ~~deleted~~"),
        "<p>H<sub>2</sub>O and <del>deleted</del></p>\n"
    );
}