hyperchad_docs_site 0.4.0

HyperChad documentation site framework
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

#![allow(clippy::module_name_repetitions)]

//! Theme values used by the default docs layout.

use hyperchad::color::Color;

/// Visual theme for a docs site.
#[derive(Clone)]
pub struct Theme {
    /// Page background color.
    pub background: Color,
    /// Surface/panel background color.
    pub surface: Color,
    /// Primary body text color.
    pub text_primary: Color,
    /// Secondary body text color.
    pub text_secondary: Color,
    /// Muted text color.
    pub text_muted: Color,
    /// Accent color for links and highlights.
    pub accent: Color,
    /// Border color.
    pub border: Color,
    /// Monospace font stack.
    pub mono_font: &'static str,
}

impl Theme {
    /// Return the default dark documentation theme.
    #[must_use]
    pub fn default_dark() -> Self {
        Self::terminal_dark()
    }

    /// Return a terminal-inspired dark documentation theme.
    #[must_use]
    pub fn terminal_dark() -> Self {
        Self {
            background: Color::from_hex("#0d1117"),
            surface: Color::from_hex("#161b22"),
            text_primary: Color::from_hex("#f0f6fc"),
            text_secondary: Color::from_hex("#c9d1d9"),
            text_muted: Color::from_hex("#8b949e"),
            accent: Color::from_hex("#7ee787"),
            border: Color::from_hex("#21262d"),
            mono_font: "'SF Mono', 'Cascadia Code', 'Fira Code', Menlo, Consolas, monospace",
        }
    }
}

impl Default for Theme {
    fn default() -> Self {
        Self::default_dark()
    }
}