ox_content_vite 0.11.0

Vite Environment API integration for Ox Content
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

//! Configuration for Ox Content Vite plugin.

use serde::{Deserialize, Serialize};

/// Configuration for the Ox Content Vite plugin.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OxContentConfig {
    /// Source directory for Markdown files.
    #[serde(default = "default_src_dir")]
    pub src_dir: String,

    /// Output directory for generated files.
    #[serde(default = "default_out_dir")]
    pub out_dir: String,

    /// Base path for the site.
    #[serde(default)]
    pub base: String,

    /// Enable GFM extensions.
    #[serde(default = "default_true")]
    pub gfm: bool,

    /// Theme configuration.
    #[serde(default)]
    pub theme: ThemeConfig,

    /// Site metadata.
    #[serde(default)]
    pub site: SiteConfig,

    /// OG image generation configuration.
    #[serde(default)]
    pub og_image: OgImageConfig,
}

impl Default for OxContentConfig {
    fn default() -> Self {
        Self {
            src_dir: default_src_dir(),
            out_dir: default_out_dir(),
            base: String::new(),
            gfm: true,
            theme: ThemeConfig::default(),
            site: SiteConfig::default(),
            og_image: OgImageConfig::default(),
        }
    }
}

fn default_src_dir() -> String {
    "docs".to_string()
}

fn default_out_dir() -> String {
    "dist".to_string()
}

fn default_true() -> bool {
    true
}

/// Theme configuration.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ThemeConfig {
    /// Theme name or path.
    #[serde(default)]
    pub name: Option<String>,

    /// Custom CSS path.
    #[serde(default)]
    pub custom_css: Option<String>,

    /// Enable dark mode.
    #[serde(default = "default_true")]
    pub dark_mode: bool,

    /// Primary color.
    #[serde(default)]
    pub primary_color: Option<String>,
}

/// Site metadata configuration.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SiteConfig {
    /// Site title.
    #[serde(default)]
    pub title: Option<String>,

    /// Site description.
    #[serde(default)]
    pub description: Option<String>,

    /// Site URL.
    #[serde(default)]
    pub url: Option<String>,

    /// Site logo.
    #[serde(default)]
    pub logo: Option<String>,

    /// Social links.
    #[serde(default)]
    pub social: Vec<SocialLink>,
}

/// Social link configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SocialLink {
    /// Platform name (e.g., "github", "twitter").
    pub platform: String,
    /// URL to the social profile.
    pub url: String,
}

/// OG image generation configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct OgImageConfig {
    /// Enable OG image generation.
    #[serde(default)]
    pub enabled: bool,

    /// Background color.
    #[serde(default = "default_og_bg")]
    pub background: String,

    /// Text color.
    #[serde(default = "default_og_text")]
    pub text_color: String,

    /// Font family.
    #[serde(default)]
    pub font_family: Option<String>,
}

impl Default for OgImageConfig {
    fn default() -> Self {
        Self {
            enabled: false,
            background: default_og_bg(),
            text_color: default_og_text(),
            font_family: None,
        }
    }
}

fn default_og_bg() -> String {
    "#1a1a1a".to_string()
}

fn default_og_text() -> String {
    "#ffffff".to_string()
}