yar_site 0.10.0

Library for creating and working with static sites for yar.
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

use std::path::{Path, PathBuf};

use serde::{Deserialize, Serialize};
use url::Url;

/// Configuration values for a site.
#[derive(Debug, Deserialize, Serialize, Clone, Default)]
pub struct Config {
    /// Site specific configuration.
    pub site: SiteConfig,
    /// Configuration for hooks (commands that are run accompanying some event).
    pub hooks: HooksConfig,
}

/// Site specific configuration.
///
/// All of this information is available to templates under the `site` variable.
#[derive(Debug, Deserialize, Serialize, Clone)]
pub struct SiteConfig {
    /// The url to the site.
    pub url: Url,
    /// The authors of the site.
    pub authors: Option<Vec<String>>,
    /// The title of the site.
    pub title: Option<String>,
    /// The description of the site.
    pub description: Option<String>,
    /// An email to accompany the site with.
    pub email: Option<String>,
    /// The path to the root of the site.
    ///
    /// This is where the static site generator will read in and process files from.
    pub root: PathBuf,
    /// The path the static site generator will render the site to.
    pub output_path: PathBuf,
    /// Whether or not a development build is being run.
    pub development: bool,
    /// The syntax highlighting theme.
    pub syntax_theme: String,
    /// A path for discovering syntax highlighting themes.
    pub syntax_theme_path: Option<PathBuf>,
    pub db_file: PathBuf,
}

/// Configuration for hooks.
///
/// Hooks are commands that are run accompanying
/// some event, e.g after processing.
#[derive(Debug, Serialize, Deserialize, Clone, Default)]
pub struct HooksConfig {
    /// Hooks that are run once the static site generator has finished processing.
    pub post: Vec<PostHook>,
}

#[derive(Debug, Serialize, Deserialize, Clone)]
pub struct PostHook {
    /// The command to run.
    pub cmd: String,
    /// An optional help message.
    pub help: Option<String>,
}

impl Default for SiteConfig {
    fn default() -> Self {
        Self {
            url: Url::parse("http://0.0.0.0:8000/").expect("Invalid default URL?"),
            authors: None,
            title: None,
            description: None,
            email: None,
            root: Path::new("site/").to_owned(),
            output_path: Path::new("public/").to_owned(),
            development: false,
            syntax_theme: String::from("base16-ocean.dark"),
            syntax_theme_path: None,
            db_file: Path::new("site.db").to_owned(),
        }
    }
}