Struct Config 

pub struct Config {
    pub title: Option<String>,
    pub description: Option<String>,
    pub base: Option<String>,
    pub locales: HashMap<String, LocaleConfig>,
    pub theme: ThemeConfig,
    pub plugins: Vec<PluginConfig>,
    pub markdown: MarkdownConfig,
    pub build: BuildConfig,
}

Nargo Document 配置 - 兼容 VuTeX 配置格式

Fields

title: Option<String>

站点标题

description: Option<String>

站点描述

base: Option<String>

基础路径

locales: HashMap<String, LocaleConfig>

语言配置

theme: ThemeConfig

主题配置

plugins: Vec<PluginConfig>

插件配置

markdown: MarkdownConfig

Markdown 配置

build: BuildConfig

构建配置

Implementations

impl Config

pub fn load_from_file<P: AsRef<Path>>(path: P) -> Result<Self, ConfigError>

从文件加载配置，根据文件扩展名自动选择解析器

Arguments

• path - 配置文件的路径

Errors

返回 ConfigError 如果文件读取或解析失败

pub fn load_from_json_str(json_str: &str) -> Result<Self, ConfigError>

从 JSON 字符串加载配置

Arguments

• json_str - JSON 格式的配置字符串

Errors

返回 ConfigError::JsonParseError 如果 JSON 解析失败

pub fn load_from_toml_str(toml_str: &str) -> Result<Self, ConfigError>

从 TOML 字符串加载配置

Arguments

• toml_str - TOML 格式的配置字符串

Errors

返回 ConfigError::TomlParseError 如果 TOML 解析失败

pub fn load_from_dir<P: AsRef<Path>>(dir: P) -> Result<Self, ConfigError>

从目录中查找并加载配置文件

按以下顺序查找配置文件：

1. nargodoc.config.toml
2. nargodoc.config.json
3. vutex.config.toml (兼容)
4. vutex.config.json (兼容)

Arguments

• dir - 要搜索的目录路径

Errors

返回 ConfigError 如果配置文件读取或解析失败

pub fn to_json(&self) -> Result<String, Error>

将配置序列化为 JSON 字符串

Errors

返回 serde_json::Error 如果序列化失败

pub fn to_toml(&self) -> Result<String, Error>

将配置序列化为 TOML 字符串

Errors

返回 toml::ser::Error 如果序列化失败

pub fn new() -> Self

创建新的配置

pub fn with_title(self, title: String) -> Self

设置站点标题

pub fn with_description(self, description: String) -> Self

设置站点描述

pub fn add_locale(self, lang: String, config: LocaleConfig) -> Self

添加语言配置

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConfigValidation for Config

fn validate(&self) -> Result<(), ConfigError>

验证配置的有效性

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Config