SiteConfig

Home
API Reference
Moka
Docs
Core
Configuration
SiteConfig

Record

public record SiteConfig : System.IEquatable<Moka.Docs.Core.Configuration.SiteConfig>

Namespace: Moka.Docs.Core.Configuration

Top-level configuration for a MokaDocs site, parsed from mokadocs.yaml.

Inheritance

Implements: System.IEquatable<Moka.Docs.Core.Configuration.SiteConfig>

Properties

Name	Description
`Build`	Build options.
`Cloud`	Cloud feature configuration.
`Content`	Content source configuration.
`Features`	Feature toggles.
`Nav`	Navigation overrides.
`Plugins`	Plugin declarations.
`Site`	Site metadata (title, description, URL, etc.).
`Theme`	Theme configuration.

Build

BuildConfig SiteConfig.Build { get; init; }

Build options.

Cloud

CloudConfig SiteConfig.Cloud { get; init; }

Cloud feature configuration.

Content

ContentConfig SiteConfig.Content { get; init; }

Content source configuration.

Features

FeaturesConfig SiteConfig.Features { get; init; }

Feature toggles.

Nav

List<NavItem> SiteConfig.Nav { get; init; }

Navigation overrides.

Plugins

List<PluginDeclaration> SiteConfig.Plugins { get; init; }

Plugin declarations.

Site

SiteMetadata SiteConfig.Site { get; init; }

Site metadata (title, description, URL, etc.).

Theme

ThemeConfig SiteConfig.Theme { get; init; }

Theme configuration.

Type Relationships

classDiagram
                    style SiteConfig fill:#f9f,stroke:#333,stroke-width:2px
                    SiteConfig ..|> SiteConfig~ : implements

View Source

/// <summary>
///     Top-level configuration for a MokaDocs site, parsed from mokadocs.yaml.
/// </summary>
public sealed record SiteConfig
{
    /// <summary>Site metadata (title, description, URL, etc.).</summary>
    public required SiteMetadata Site { get; init; }
    /// <summary>Content source configuration.</summary>
    public ContentConfig Content { get; init; } = new();
    /// <summary>Theme configuration.</summary>
    public ThemeConfig Theme { get; init; } = new();
    /// <summary>Navigation overrides.</summary>
    public List<NavItem> Nav { get; init; } = [];
    /// <summary>Feature toggles.</summary>
    public FeaturesConfig Features { get; init; } = new();
    /// <summary>Plugin declarations.</summary>
    public List<PluginDeclaration> Plugins { get; init; } = [];
    /// <summary>Cloud feature configuration.</summary>
    public CloudConfig Cloud { get; init; } = new();
    /// <summary>Build options.</summary>
    public BuildConfig Build { get; init; } = new();
}