htmd 0.5.4

A turndown.js inspired HTML to Markdown converter.
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

/// The HTML to Markdown converting options.
#[derive(Debug)]
pub struct Options {
    pub heading_style: HeadingStyle,
    pub hr_style: HrStyle,
    pub br_style: BrStyle,
    pub link_style: LinkStyle,
    pub link_reference_style: LinkReferenceStyle,
    pub code_block_style: CodeBlockStyle,
    pub code_block_fence: CodeBlockFence,
    pub bullet_list_marker: BulletListMarker,
    /// The number of spaces between the bullet character and the content.
    pub ul_bullet_spacing: u8,
    /// The number of spaces between the period character and the content.
    pub ol_number_spacing: u8,
    /// If true, the whitespace in inline \<code> tags will be preserved.
    pub preformatted_code: bool,
    pub translation_mode: TranslationMode,
}

impl Default for Options {
    fn default() -> Self {
        Self {
            heading_style: HeadingStyle::Atx,
            hr_style: HrStyle::Asterisks,
            br_style: BrStyle::TwoSpaces,
            link_style: LinkStyle::Inlined,
            link_reference_style: LinkReferenceStyle::Full,
            code_block_style: CodeBlockStyle::Fenced,
            code_block_fence: CodeBlockFence::Backticks,
            bullet_list_marker: BulletListMarker::Asterisk,
            ul_bullet_spacing: 3,
            ol_number_spacing: 2,
            preformatted_code: false,
            translation_mode: TranslationMode::Pure,
        }
    }
}

#[derive(PartialEq, Debug, Clone, Copy)]
pub enum HeadingStyle {
    Atx,
    Setex,
}

#[derive(PartialEq, Debug, Clone, Copy)]
pub enum HrStyle {
    /// `- - -`
    Dashes,
    /// `* * *`
    Asterisks,
    /// `_ _ _`
    Underscores,
}

#[derive(PartialEq, Debug, Clone, Copy)]
pub enum BrStyle {
    TwoSpaces,
    Backslash,
}

#[derive(PartialEq, Debug, Clone, Copy)]
pub enum CodeBlockStyle {
    Indented,
    Fenced,
}

#[derive(PartialEq, Debug, Clone, Copy)]
pub enum CodeBlockFence {
    /// Wrap code with `~~~`
    Tildes,
    /// Wrap code with ` ``` `
    Backticks,
}

#[derive(PartialEq, Debug, Clone, Copy)]
pub enum BulletListMarker {
    /// List items will start with `*`
    Asterisk,
    /// List items will start with `-`
    Dash,
}

#[derive(PartialEq, Debug, Clone, Copy)]
pub enum LinkStyle {
    Inlined,
    /// Will convert links with the same URL and link text to
    /// [Autolinks](https://spec.commonmark.org/0.31.2/#autolink).
    InlinedPreferAutolinks,
    Referenced,
}

#[derive(PartialEq, Debug, Clone, Copy)]
pub enum LinkReferenceStyle {
    Full,
    Collapsed,
    Shortcut,
}

#[derive(PartialEq, Debug, Clone, Copy)]
pub enum TranslationMode {
    /// In pure translation mode, always translate HTML to Markdown, even when
    /// that translation drops attributes in the HTML.
    Pure,
    /// In faithful translation mode, preserve the original HTML by embedding
    /// HTML tags as necessary to ensure that translation back to HTML produces
    /// an (almost) identical result.
    Faithful,
}