oranda 0.6.5

🎁 generate beautiful landing pages for your projects
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

use crate::config::{ApplyLayer, ApplyValExt};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Config for tweaking the changelog page generation
#[derive(Debug, Clone)]
pub struct ChangelogConfig {
    /// Whether to attempt to read from the local changelog file
    pub read_changelog_file: bool,
    /// Whether to generate a RSS file
    pub rss_feed: bool,
}

/// The config for generating a separate changelog page
#[derive(Debug, Default, Serialize, Deserialize, JsonSchema)]
pub struct ChangelogLayer {
    /// Whether we factor in the local `CHANGELOG.md` file, attempt to parse
    /// it, and try and match version headings to release versions that we
    /// detect.
    pub read_changelog_file: Option<bool>,
    /// Whether to generate a RSS file under `changelog.rss`.
    pub rss_feed: Option<bool>,
}

impl Default for ChangelogConfig {
    fn default() -> Self {
        ChangelogConfig {
            read_changelog_file: true,
            rss_feed: true,
        }
    }
}

impl ApplyLayer for ChangelogConfig {
    type Layer = ChangelogLayer;
    fn apply_layer(&mut self, layer: Self::Layer) {
        // This is intentionally written slightly cumbersome to make you update this
        let ChangelogLayer {
            read_changelog_file,
            rss_feed,
        } = layer;
        self.read_changelog_file.apply_val(read_changelog_file);
        self.rss_feed.apply_val(rss_feed);
    }
}