ratatui-markdown 0.3.6

Markdown rendering, syntax highlighting, collapsible trees, and rich scroll widgets for ratatui
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

#[derive(Debug, Clone, PartialEq)]
pub enum MarkdownBlock {
    Heading1(String),
    Heading2(String),
    Heading3(String),
    Paragraph(Vec<String>),
    CodeBlock {
        lang: String,
        code: String,
        header_override: Option<String>,
        footer_override: Option<String>,
        prefix_override: Option<String>,
    },
    InlineCode(String),
    ListItem(String, u8),
    TaskItem {
        text: String,
        indent: u8,
        checked: bool,
    },
    Blockquote {
        level: u8,
        children: Vec<Self>,
        header_override: Option<String>,
        footer_override: Option<String>,
    },
    HorizontalRule,
    BlankLine,
    Table {
        headers: Vec<String>,
        rows: Vec<Vec<String>>,
    },
    Image {
        alt: String,
        path: String,
    },
}

impl MarkdownBlock {
    pub fn code_block(lang: impl Into<String>, code: impl Into<String>) -> Self {
        Self::CodeBlock {
            lang: lang.into(),
            code: code.into(),
            header_override: None,
            footer_override: None,
            prefix_override: None,
        }
    }

    pub fn blockquote_text(text: impl Into<String>) -> Self {
        Self::Blockquote {
            level: 1,
            children: vec![Self::Paragraph(vec![text.into()])],
            header_override: None,
            footer_override: None,
        }
    }

    pub fn blockquote(level: u8, children: Vec<Self>) -> Self {
        Self::Blockquote {
            level,
            children,
            header_override: None,
            footer_override: None,
        }
    }

    pub fn blockquote_with_overrides(
        level: u8,
        children: Vec<Self>,
        header_override: Option<String>,
        footer_override: Option<String>,
    ) -> Self {
        Self::Blockquote {
            level,
            children,
            header_override,
            footer_override,
        }
    }

    pub fn line_count(&self) -> usize {
        match self {
            Self::Heading1(_)
            | Self::Heading2(_)
            | Self::Heading3(_)
            | Self::InlineCode(_)
            | Self::HorizontalRule
            | Self::BlankLine => 1,
            Self::Paragraph(lines) => lines.len().max(1),
            Self::CodeBlock { code, .. } => code.lines().count().max(1) + 2,
            Self::ListItem(_, _) | Self::TaskItem { .. } => 1,
            Self::Blockquote {
                children,
                header_override,
                footer_override,
                ..
            } => {
                let base = children
                    .iter()
                    .map(|c| c.line_count())
                    .sum::<usize>()
                    .max(1);
                let extra = header_override.as_ref().map_or(0, |_| 1)
                    + footer_override.as_ref().map_or(0, |_| 1);
                base + extra
            }
            Self::Table { rows, .. } => {
                let header_lines = 2;
                let row_lines = rows.len() * 2 + 1;
                header_lines + row_lines
            }
            Self::Image { .. } => 1,
        }
    }
}

#[derive(Debug)]
pub(crate) enum TextToken {
    Word(String),
    Space,
    Newline,
}