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
108
109
110

use ferromark::{Options, to_html_with_options};

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

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

#[test]
fn basic_superscript() {
    assert_eq!(superscript_html("2^10^"), "<p>2<sup>10</sup></p>\n");
}

#[test]
fn superscript_in_paragraph() {
    assert_eq!(
        superscript_html("before ^sup^ after"),
        "<p>before <sup>sup</sup> after</p>\n"
    );
}

#[test]
fn superscript_with_emphasis_inside() {
    assert_eq!(
        superscript_html("^**bold**^"),
        "<p><sup><strong>bold</strong></sup></p>\n"
    );
}

#[test]
fn superscript_disabled() {
    assert_eq!(no_superscript_html("2^10^"), "<p>2^10^</p>\n");
}

#[test]
fn unmatched_superscript_is_literal() {
    assert_eq!(superscript_html("^sup"), "<p>^sup</p>\n");
    assert_eq!(superscript_html("sup^"), "<p>sup^</p>\n");
}

#[test]
fn empty_superscript_is_literal() {
    assert_eq!(superscript_html("^^"), "<p>^^</p>\n");
}

#[test]
fn whitespace_only_superscript_is_literal() {
    assert_eq!(superscript_html("^  ^"), "<p>^  ^</p>\n");
}

#[test]
fn code_span_wins_over_superscript() {
    assert_eq!(superscript_html("`^x^`"), "<p><code>^x^</code></p>\n");
}

#[test]
fn links_work_inside_superscript() {
    assert_eq!(
        superscript_html("^[link](https://example.com)^"),
        "<p><sup><a href=\"https://example.com\">link</a></sup></p>\n"
    );
}

#[test]
fn superscript_works_inside_link_text() {
    assert_eq!(
        superscript_html("[^x^](https://example.com)"),
        "<p><a href=\"https://example.com\"><sup>x</sup></a></p>\n"
    );
}

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

#[test]
fn superscript_does_not_break_footnote_refs() {
    let result = to_html_with_options(
        "[^fn] and 2^2^\n\n[^fn]: Footnote",
        &Options {
            superscript: true,
            footnotes: true,
            heading_ids: false,
            ..Options::default()
        },
    );

    assert!(result.contains("<sup>2</sup>"), "{result}");
    assert!(result.contains("data-footnote-ref>1</a></sup>"), "{result}");
}