hyperchad_docs_site 0.4.0

HyperChad documentation site framework
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

//! Renderer-agnostic markdown presentation for documentation pages.

use hyperchad::color::Color;
use hyperchad::transformer::{Container, Element, HeaderSize, Number, TextDecoration};
use hyperchad::transformer_models::{
    FontWeight, LayoutDirection, LayoutOverflow, TextDecorationLine, TextDecorationStyle,
    WhiteSpace,
};

use crate::theme::Theme;

/// Theme-driven markdown style policy for documentation pages.
pub struct MarkdownStyle<'a> {
    theme: &'a Theme,
    font_family: &'a str,
}

impl<'a> MarkdownStyle<'a> {
    /// Create a markdown style policy from the docs theme and body font family.
    #[must_use]
    pub const fn new(theme: &'a Theme, font_family: &'a str) -> Self {
        Self { theme, font_family }
    }

    /// Apply this style policy to a rendered markdown container tree.
    pub fn apply(&self, container: &mut Container) {
        self.apply_inner(container, false);
    }

    fn apply_inner(&self, container: &mut Container, in_table_head: bool) {
        let child_in_table_head = in_table_head || matches!(container.element, Element::THead);
        for child in &mut container.children {
            self.apply_inner(child, child_in_table_head);
        }
        self.apply_container(container, in_table_head);
    }

    fn apply_container(&self, container: &mut Container, in_table_head: bool) {
        if has_class(container, "inline-code") {
            self.apply_inline_code(container);
        }

        if has_class(container, "markdown-link") {
            self.apply_link(container);
        }

        match &container.element {
            Element::Div if has_class(container, "markdown-p") => apply_paragraph(container),
            Element::Div if has_class(container, "markdown-code-block") => {
                self.apply_code_block(container);
            }
            Element::Div if has_class(container, "markdown-blockquote") => {
                self.apply_blockquote(container);
            }
            Element::Div if has_class(container, "markdown-hr") => self.apply_rule(container),
            Element::Heading { size } => self.apply_heading(container, *size),
            Element::UnorderedList | Element::OrderedList => apply_list(container),
            Element::ListItem => apply_list_item(container),
            Element::Image { .. } => apply_image(container),
            Element::Input { .. } => apply_task_marker(container),
            Element::Table => self.apply_table(container),
            Element::THead => apply_table_head(container, self.theme.surface),
            Element::TD { .. } if in_table_head => self.apply_table_header_cell(container),
            Element::TH { .. } => self.apply_table_header_cell(container),
            Element::TD { .. } => self.apply_table_cell(container),
            _ => {}
        }
    }

    fn apply_inline_code(&self, container: &mut Container) {
        container.font_family = Some(vec![self.theme.mono_font.to_string()]);
        container.background = Some(self.theme.surface);
        container.color = Some(self.theme.text_primary);
        container.padding_left = Some(Number::from(4));
        container.padding_right = Some(Number::from(4));
        container.padding_top = Some(Number::from(2));
        container.padding_bottom = Some(Number::from(2));
        set_radius(container, 3);
    }

    fn apply_link(&self, container: &mut Container) {
        container.color = Some(self.theme.accent);
        container.text_decoration = Some(TextDecoration {
            color: None,
            line: vec![TextDecorationLine::Underline],
            style: Some(TextDecorationStyle::Solid),
            thickness: None,
        });
    }

    fn apply_code_block(&self, container: &mut Container) {
        container.font_family = Some(vec![self.theme.mono_font.to_string()]);
        container.background = Some(self.theme.background);
        container.color = Some(self.theme.text_primary);
        container.padding_left = Some(Number::from(16));
        container.padding_right = Some(Number::from(16));
        container.padding_top = Some(Number::from(16));
        container.padding_bottom = Some(Number::from(16));
        container.margin_top = Some(Number::from(16));
        container.margin_bottom = Some(Number::from(16));
        container.overflow_x = LayoutOverflow::Scroll;
        container.white_space = Some(WhiteSpace::PreserveWrap);
        set_radius(container, 6);
        set_border(container, self.theme.border, 1);
    }

    fn apply_blockquote(&self, container: &mut Container) {
        container.border_left = Some((self.theme.border, Number::from(4)));
        container.padding_left = Some(Number::from(16));
        container.margin_top = Some(Number::from(16));
        container.margin_bottom = Some(Number::from(16));
        container.color = Some(self.theme.text_muted);
    }

    fn apply_rule(&self, container: &mut Container) {
        container.height = Some(Number::from(1));
        container.background = Some(self.theme.border);
        container.margin_top = Some(Number::from(24));
        container.margin_bottom = Some(Number::from(24));
    }

    fn apply_heading(&self, container: &mut Container, size: HeaderSize) {
        let (margin_top, margin_bottom, font_size) = match size {
            HeaderSize::H1 => (32, 16, 32),
            HeaderSize::H2 => (24, 16, 24),
            HeaderSize::H3 => (24, 16, 20),
            HeaderSize::H4 => (16, 8, 16),
            HeaderSize::H5 => (16, 8, 14),
            HeaderSize::H6 => (16, 8, 13),
        };
        container.color = Some(if matches!(size, HeaderSize::H6) {
            self.theme.text_muted
        } else {
            self.theme.text_primary
        });
        container.font_family = Some(vec![self.theme.mono_font.to_string()]);
        container.font_weight = Some(FontWeight::Bold);
        container.margin_top = Some(Number::from(margin_top));
        container.margin_bottom = Some(Number::from(margin_bottom));
        container.font_size = Some(Number::from(font_size));
    }

    fn apply_table(&self, container: &mut Container) {
        container.margin_top = Some(Number::from(16));
        container.margin_bottom = Some(Number::from(16));
        container.min_width = Some(Number::IntegerPercent(100));
        container.overflow_x = LayoutOverflow::Scroll;
        container.border_top = Some((self.theme.border, Number::from(1)));
        container.border_left = Some((self.theme.border, Number::from(1)));
    }

    fn apply_table_header_cell(&self, container: &mut Container) {
        self.apply_table_cell(container);
        container.background = Some(self.theme.surface);
        container.color = Some(self.theme.text_primary);
        container.font_weight = Some(FontWeight::Bold);
    }

    fn apply_table_cell(&self, container: &mut Container) {
        container.padding_left = Some(Number::from(8));
        container.padding_right = Some(Number::from(8));
        container.padding_top = Some(Number::from(8));
        container.padding_bottom = Some(Number::from(8));
        container.border_right = Some((self.theme.border, Number::from(1)));
        container.border_bottom = Some((self.theme.border, Number::from(1)));
    }

    /// Apply body-level markdown text defaults to the root markdown container.
    pub fn apply_body(&self, container: &mut Container) {
        container.color = Some(self.theme.text_secondary);
        container.font_family = Some(vec![self.font_family.to_string()]);
        container.font_size = Some(Number::from(14));
        container.overflow_x = LayoutOverflow::Scroll;
    }
}

fn apply_paragraph(container: &mut Container) {
    container.margin_bottom = Some(Number::from(16));
}

fn apply_list_item(container: &mut Container) {
    container.margin_bottom = Some(Number::from(4));
}

fn apply_list(container: &mut Container) {
    container.margin_top = Some(Number::from(16));
    container.margin_bottom = Some(Number::from(16));
    container.padding_left = Some(Number::from(32));
    container.direction = LayoutDirection::Column;
}

const fn apply_table_head(container: &mut Container, background: Color) {
    container.background = Some(background);
}

fn apply_image(container: &mut Container) {
    container.max_width = Some(Number::IntegerPercent(100));
}

fn apply_task_marker(container: &mut Container) {
    container.margin_right = Some(Number::from(8));
}

fn set_radius(container: &mut Container, radius: i32) {
    let radius = Number::from(radius);
    container.border_top_left_radius = Some(radius.clone());
    container.border_top_right_radius = Some(radius.clone());
    container.border_bottom_left_radius = Some(radius.clone());
    container.border_bottom_right_radius = Some(radius);
}

fn set_border(container: &mut Container, color: Color, width: i32) {
    let border = (color, Number::from(width));
    container.border_top = Some(border.clone());
    container.border_right = Some(border.clone());
    container.border_bottom = Some(border.clone());
    container.border_left = Some(border);
}

fn has_class(container: &Container, class: &str) -> bool {
    container.classes.iter().any(|value| value == class)
}