docket 0.1.2

Simple markdown to HTML documentation rendering
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

use std::io::{self, Write};
use std::borrow::Cow;
use std::path::PathBuf;
use renderable::Renderable;
use page::PageInfo;
use pulldown_cmark::{Parser, html};
use util::read_file_to_string;

pub struct Index {
    /// The project title
    title: String,

    /// The path to the markdown source
    path: Option<PathBuf>,

    /// Pages to include in this index.
    pages: Vec<PageInfo>,
}

impl Renderable for Index {
    fn get_slug(&self) -> String {
        "".into()
    }

    fn get_title<'t>(&'t self) -> Cow<'t, str> {
        (&self.title[..]).into()
    }

    fn write_header<T: Write>(&self, file: &mut T, title: &str) -> io::Result<()> {
        write!(
            file,
            r#"<header class="index-heading"><h1><a href="">{}</a></h1></header>"#,
            title
        )
    }

    fn write_body<T: Write>(&self, file: &mut T) -> io::Result<()> {
        if let Some(ref index_md) = self.path {
            debug!("found index file, rendering");
            let contents = read_file_to_string(&index_md);
            let parsed = Parser::new(&contents);
            let mut rendered = String::new();
            html::push_html(&mut rendered, parsed);
            write!(file, "{}", rendered)?;
        }

        // List of pages in the index
        debug!("listing pages in index");
        write!(file, "<h2>Table of Contents</h2>")?;
        write!(file, r#"<ol class="index-toc">"#)?;
        for page in self.pages.iter() {
            write!(
                file,
                r#"<li><a href="{}">{}</a></li>"#,
                page.slug,
                page.title
            )?;
        }
        write!(file, "</ol>")?;

        Ok(())
    }
}

impl Index {
    pub fn new(title: String, md_source: Option<PathBuf>, pages: Vec<PageInfo>) -> Self {
        Index {
            title: title,
            path: md_source,
            pages: pages,
        }
    }
}