mdcast 0.3.0

Markdown → DOCX/ODT/PDF/PPTX/HTML-reveal with per-page layout templates, powered by pandoc and typst
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
111
112
113
114

use super::*;

#[test]
fn thematic_break_splits() {
    let md = "page one\n\n---\n\npage two\n";
    let pages = split(md);
    assert_eq!(pages.len(), 2);
    assert_eq!(pages[0].body, "page one");
    assert_eq!(pages[1].body, "page two");
    assert!(pages.iter().all(|p| p.explicit_class.is_none()));
}

#[test]
fn html_page_wrapper_extracts_class() {
    let md = "<page class=\"hero\">\n# Quarterly\n</page>\n";
    let pages = split(md);
    assert_eq!(pages.len(), 1);
    assert_eq!(pages[0].explicit_class.as_deref(), Some("hero"));
    assert_eq!(pages[0].body, "# Quarterly");
}

#[test]
fn fenced_div_extracts_class() {
    let md = "::: {.thanks}\nThank you!\n:::\n";
    let pages = split(md);
    assert_eq!(pages.len(), 1);
    assert_eq!(pages[0].explicit_class.as_deref(), Some("thanks"));
    assert_eq!(pages[0].body, "Thank you!");
}

#[test]
fn mixed_syntaxes_with_thematic_breaks() {
    let md = "intro paragraph\n\n---\n\n<page class=\"hero\">\n# Big\n</page>\n\nmore body\n\n---\n\n::: {.thanks}\nbye\n:::\n";
    let pages = split(md);
    assert_eq!(pages.len(), 4);
    assert_eq!(pages[0].explicit_class, None);
    assert_eq!(pages[0].body, "intro paragraph");
    assert_eq!(pages[1].explicit_class.as_deref(), Some("hero"));
    assert_eq!(pages[2].explicit_class, None);
    assert_eq!(pages[2].body, "more body");
    assert_eq!(pages[3].explicit_class.as_deref(), Some("thanks"));
}

#[test]
fn self_closing_html_page_is_an_empty_page() {
    let md = "<page class=\"section\" />\n\nafter\n";
    let pages = split(md);
    assert_eq!(pages.len(), 2);
    assert_eq!(pages[0].explicit_class.as_deref(), Some("section"));
    assert_eq!(pages[0].body, "");
    assert_eq!(pages[1].explicit_class, None);
    assert_eq!(pages[1].body, "after");
}

#[test]
fn self_closing_html_page_no_space_before_slash() {
    let md = "<page class=\"section\"/>\n\nafter\n";
    let pages = split(md);
    assert_eq!(pages.len(), 2);
    assert_eq!(pages[0].explicit_class.as_deref(), Some("section"));
    assert_eq!(pages[0].body, "");
}

#[test]
fn nested_fenced_divs_do_not_close_page_early() {
    let md =
        "::: {.columns}\n::: {.column}\nleft\n:::\n::: {.column}\nright\n:::\n:::\n\nnext page\n";
    let pages = split(md);
    assert_eq!(pages.len(), 2);
    assert_eq!(pages[0].explicit_class.as_deref(), Some("columns"));
    assert!(pages[0].body.contains("left"));
    assert!(pages[0].body.contains("right"));
    assert_eq!(pages[1].explicit_class, None);
    assert_eq!(pages[1].body, "next page");
}

#[test]
fn dashes_in_code_fence_are_not_breaks() {
    let md = "page one\n\n```\n---\n```\n\nstill page one\n";
    let pages = split(md);
    assert_eq!(pages.len(), 1);
    assert!(pages[0].body.contains("---"));
}

#[test]
fn empty_input_produces_no_pages() {
    assert!(split("").is_empty());
    assert!(split("\n\n").is_empty());
}

#[test]
fn trait_default_matches_free_function() {
    let md = "a\n\n---\n\nb\n";
    assert_eq!(DefaultSplitter.split(md), split(md));
}

#[test]
fn custom_splitter_can_be_plugged_in() {
    struct LineSplitter;
    impl PageSplitter for LineSplitter {
        fn split(&self, md: &str) -> Vec<RawPage> {
            md.lines()
                .filter(|l| !l.is_empty())
                .map(|l| RawPage {
                    explicit_class: None,
                    body: l.to_string(),
                })
                .collect()
        }
    }
    let pages = LineSplitter.split("a\nb\nc\n");
    assert_eq!(pages.len(), 3);
    assert_eq!(pages[1].body, "b");
}