oak-markdown 0.0.11

High-performance incremental Markdown parser for the oak ecosystem with flexible configuration, optimized for documentation and content creation.
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

#![doc = include_str!("readme.md")]
use oak_core::{Language, LanguageCategory};

/// Configuration for the Markdown language features.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct MarkdownLanguage {
    /// Enable math formulas.
    ///
    /// Example: `$a^2 + b^2 = c^2$` or `$$E = mc^2$$`
    pub allow_math: bool,
    /// Enable tables.
    ///
    /// Example:
    /// | Header |
    /// | ------ |
    /// | Cell   |
    pub allow_tables: bool,
    /// Enable task lists.
    ///
    /// Example: `- [ ] Task` or `- [x] Done`
    pub allow_task_lists: bool,
    /// Enable strikethrough.
    ///
    /// Example: `~~deleted~~`
    pub allow_strikethrough: bool,
    /// Enable footnotes.
    ///
    /// Example: `[^1]` and `[^1]: Note`
    pub allow_footnotes: bool,
    /// Enable front matter (YAML/TOML/JSON).
    ///
    /// Example:
    /// ---
    /// title: Hello
    /// ---
    pub allow_front_matter: bool,
    /// Enable definition lists.
    ///
    /// Example:
    /// Term
    /// : Definition
    pub allow_definition_lists: bool,
    /// Enable superscript and subscript.
    ///
    /// Example: `^sup^` or `~sub~`
    pub allow_subscript: bool,
    /// Enable autolinks.
    ///
    /// Example: `<https://example.com>`
    pub allow_autolinks: bool,
    /// Enable abbreviations.
    ///
    /// Example: `*[HTML]: HyperText Markup Language`
    pub allow_abbreviations: bool,
    /// Enable indented code blocks.
    ///
    /// Example:
    ///     code block
    pub allow_indented_code_blocks: bool,
    /// Enable inline HTML tags.
    ///
    /// Example: `<div>` or `<!-- comment -->`
    pub allow_html: bool,
    /// Enable hard line breaks.
    ///
    /// Example: Two spaces at the end of a line or a backslash.
    pub allow_hard_line_breaks: bool,
    /// Enable GFM-style autolinks.
    ///
    /// Example: `https://example.com`
    pub allow_gfm_autolinks: bool,
    /// Enable ATX headings.
    ///
    /// Example: `# Heading`
    pub allow_headings: bool,
    /// Enable lists.
    ///
    /// Example: `- Item` or `1. Item`
    pub allow_lists: bool,
    /// Enable blockquotes.
    ///
    /// Example: `> Quote`
    pub allow_blockquotes: bool,
    /// Enable fenced code blocks.
    ///
    /// Example: ` ```rust `
    pub allow_fenced_code_blocks: bool,
    /// Enable horizontal rules.
    ///
    /// Example: `---` or `***`
    pub allow_horizontal_rules: bool,
    /// Enable Setext headings.
    ///
    /// Example:
    /// Heading
    /// =======
    pub allow_setext_headings: bool,
    /// Enable GFM Tagfilter.
    ///
    /// Filters certain HTML tags like `<script>`.
    pub allow_html_tagfilter: bool,
    /// Enable XML/TSX syntax.
    ///
    /// Example: `<Component />`
    pub allow_xml: bool,
}

impl MarkdownLanguage {
    /// Creates a new Markdown language configuration with default settings.
    pub fn new() -> Self {
        Self::default()
    }
}

impl Language for MarkdownLanguage {
    const NAME: &'static str = "markdown";
    const CATEGORY: LanguageCategory = LanguageCategory::Markup;

    type TokenType = crate::lexer::token_type::MarkdownTokenType;
    type ElementType = crate::parser::element_type::MarkdownElementType;
    type TypedRoot = crate::ast::MarkdownRoot;
}

impl Default for MarkdownLanguage {
    fn default() -> Self {
        Self {
            allow_math: true,
            allow_tables: true,
            allow_task_lists: true,
            allow_strikethrough: true,
            allow_footnotes: true,
            allow_front_matter: true,
            allow_definition_lists: false,
            allow_subscript: false,
            allow_autolinks: true,
            allow_abbreviations: true,
            allow_indented_code_blocks: true,
            allow_html: true,
            allow_hard_line_breaks: true,
            allow_gfm_autolinks: true,
            allow_headings: true,
            allow_lists: true,
            allow_blockquotes: true,
            allow_fenced_code_blocks: true,
            allow_horizontal_rules: true,
            allow_setext_headings: true,
            allow_html_tagfilter: false,
            allow_xml: false,
        }
    }
}