ddoc 0.18.0

doc site generator
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
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

use {
    super::{
        old_nav_link::OldNavLink,
        ui_options::UiOptions,
    },
    crate::*,
    indexmap::IndexMap,
    serde::{
        Deserialize,
        Serialize,
    },
};

/// Deprecated navigation components structure for compatibility with ddoc <= 0.11
#[derive(Debug, Clone, Default, Deserialize)]
pub struct NavComponents {
    #[serde(default)]
    header: NavDir,
    #[serde(default)]
    footer: NavDir,
    #[serde(default)]
    ui: UiOptions,
}

/// Either the header or footer navigation configuration for ddoc <= 0.11
#[derive(Debug, Clone, Default, Deserialize, Serialize)]
#[serde(transparent)]
struct NavDir {
    components: IndexMap<ClassName, NavComponent>,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(untagged)]
enum NavComponent {
    Menu(Menu),
    NavLinks(Vec<OldNavLink>),
}

impl NavComponents {
    /// Build a `ElementList` from old-style `NavComponents`, adding the
    /// parts which were implicit in ddoc <= 0.11
    pub fn to_body_composite(&self) -> Element {
        let mut children = Vec::new();
        if !self.header.is_empty() {
            children.push(Element::new_composite(
                "header",
                self.header.to_children(&self.ui),
            ));
        }
        children.push(Element::new_composite(
            "article",
            vec![
                Element::new_composite(
                    "aside.page-nav",
                    vec![ElementContent::Toc(Toc::default()).into()],
                ),
                ElementContent::Main.into(),
            ],
        ));
        if !self.footer.is_empty() {
            children.push(Element::new_composite(
                "footer",
                self.footer.to_children(&self.ui),
            ));
        }
        Element {
            classes: vec![],
            content: ElementContent::DomTree {
                tag: "body".to_string(),
                children,
            },
        }
    }
}
impl NavDir {
    pub fn is_empty(&self) -> bool {
        self.components.is_empty()
    }
    fn to_children(
        &self,
        ui: &UiOptions,
    ) -> Vec<Element> {
        let mut children = Vec::new();
        for (class, comp) in &self.components {
            match comp {
                NavComponent::Menu(_) => {
                    let menu_insert = Menu {
                        hamburger_checkbox: ui.hamburger_checkbox,
                    };
                    children.push(Element {
                        classes: vec![class.clone()],
                        content: ElementContent::Menu(menu_insert),
                    });
                }
                NavComponent::NavLinks(links) => {
                    let mut nav_children = Vec::new();
                    for link in links {
                        nav_children.push(Element {
                            classes: link.classes(),
                            content: ElementContent::Link(link.to_nav_link()),
                        });
                    }
                    let mut nav = Element::new_composite("nav", nav_children);
                    nav.classes.push(class.clone());
                    children.push(nav);
                }
            }
        }
        children
    }
}

#[test]
fn test_nav_component_deserialize() {
    #[derive(Debug, Clone, Deserialize, Serialize)]
    struct TestConfig {
        header: NavDir,
        footer: NavDir,
    }
    let hjson = r#"
        header: {
            before-menu: [
                {
                    img: img/dystroy-rust-white.svg
                    href: https://dystroy.org
                    alt: dystroy.org homepage
                    class: external-nav-link
                }
                {
                    url: /index.md
                    alt: ddoc homepage
                    label: ddoc
                    class: home-link
                }
            ]
            middle: menu
            after-menu: [
                {
                    img: img/ddoc-left-arrow.svg
                    href: --previous
                    class: previous-page-link
                    alt: Previous Page
                }
                {
                    img: img/ddoc-search.svg
                    href: --search
                    class: search-opener
                    alt: Search
                }
                {
                    img: img/ddoc-right-arrow.svg
                    url: --next
                    class: next-page-link
                    alt: Next Page
                }
                {
                    img: img/github-mark-white.svg
                    class: external-nav-link
                    alt: GitHub
                    href: https://github.com/Canop/ddoc
                }
            ]
        }
        footer: {
            right: [
                {
                    label: made with **ddoc**
                    href: https://dystroy.org/ddoc
                }
            ]
        }
    "#;
    let test_config: TestConfig = deser_hjson::from_str(hjson).unwrap();
    assert_eq!(test_config.header.components.len(), 3);
    assert_eq!(test_config.footer.components.len(), 1);
    assert!(matches!(
        test_config.header.components.get("middle").unwrap(),
        NavComponent::Menu(_)
    ));
    let NavComponent::NavLinks(links) = test_config.header.components.get("after-menu").unwrap()
    else {
        panic!("Expected NavLinks");
    };
    assert_eq!(links[2].href.as_deref(), Some("--next"));
}