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

use {
    crate::*,
    std::{
        fs,
        path::PathBuf,
    },
    termimad::crossterm::style::Stylize,
};

pub struct Page {
    pub title: String,
    pub page_path: PagePath,
    pub md_file_path: PathBuf,
}

impl Page {
    pub fn new(
        title: String,
        page_path: PagePath,
        md_file_path: PathBuf,
    ) -> Self {
        Self {
            title,
            page_path,
            md_file_path,
        }
    }

    /// Write the full HTML for this page into the given `html` String
    ///
    /// # Errors
    /// Return `DdError` variants on write errors, not on project config/data errors
    pub fn write_html(
        &self,
        html: &mut String,
        project: &Project,
    ) -> DdResult<()> {
        let Ok(md) = fs::read_to_string(&self.md_file_path) else {
            eprintln!(
                "{} {} could not be read, skipping.",
                "ERROR:".red().bold(),
                self.md_file_path.to_string_lossy().yellow()
            );
            return Ok(());
        };
        let page_writer = PageWriter::new(self, project, &md)?;
        page_writer.write_html(html)
    }
}