quick-doc-viewer 0.1.0

A quick documentation viewer for developers to preview documentations
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

use maud::{DOCTYPE, html, Markup, PreEscaped};

#[derive(Clone)]
pub struct Templates {
    nav: Markup,
}

impl Templates {
    pub fn build(special_file_paths: &Vec<String>) -> Self {
        Templates {
            nav: Templates::nav(special_file_paths),
        }
    }

    fn nav(special_file_paths: &Vec<String>) -> Markup {
        html! {
            nav {
                a href="/" { "Files" }
                " |"
                @for file_path in special_file_paths {
                    " "
                    a href=(file_path) { (file_path) }
                    " |"
                }
            }
        }
    }

    fn style(&self) -> Markup {
        html! {
            "pre,code {background: #fef;}"
            ".actions a {margin: 2px;}"
        }
    }

    fn header(&self) -> Markup {
        html! {
            header {
                (self.nav)
            }
        }
    }

    fn footer(&self) -> Markup {
        html! {
            footer {
                "Powered by "
                a href="https://github.com/zhangkaizhao/quick-doc-viewer" { "Quick doc viewer" }
            }
        }
    }

    fn layout(&self, title: &str, content: Markup) -> Markup {
        html! {
            (DOCTYPE)
            html {
                head {
                    meta charset="utf-8";
                    title { (title) }
                    style {
                        (self.style())
                    }
                }
                body {
                    (self.header())
                    h1 { (title) }
                    (content)
                    (self.footer())
                }
            }
        }
    }

    fn actions(&self, path: &str) -> Markup {
        let raw_url = path.to_string() + "?raw=true";
        let markdown_url = path.to_string() + "?format=markdown";
        let plain_text_url = path.to_string() + "?format=plain_text";
        html! {
            div class="actions" {
                a href=(raw_url) { "raw" }
                a href=(path) { "preview" }
                a href=(markdown_url) { "preview as Markdown" }
                a href=(plain_text_url) { "preview as plain text" }
            }
        }
    }

    pub fn files(&self, file_paths: &Vec<String>) -> Markup {
        self.layout("/", html! {
            ul {
                @for file_path in file_paths {
                    li {
                        a href=(file_path) { (file_path) }
                    }
                }
            }
        })
    }

    pub fn page(&self, file_path: &str, html_content: &str) -> Markup {
        self.layout(file_path, html! {
            div {
                (self.actions(file_path))
                div { (PreEscaped(html_content)) }
            }
        })
    }

    pub fn text(&self, file_path: &str, file_content: &str) -> Markup {
        self.layout(file_path, html! {
            div {
                (self.actions(file_path))
                div {
                    pre { (file_content) }
                }
            }
        })
    }
}