DocSite

Home
API Reference
Moka
Docs
Core
Content
DocSite

Record

public record DocSite : System.IEquatable<Moka.Docs.Core.Content.DocSite>

Namespace: Moka.Docs.Core.Content

Top-level model representing the entire documentation site being generated.

Inheritance

Implements: System.IEquatable<Moka.Docs.Core.Content.DocSite>

Properties

Name	Description
`ApiReference`	The API reference model, if C# projects were analyzed.
`Config`	The site configuration.
`CurrentVersion`	The current version being built.
`Navigation`	The navigation tree for the sidebar.
`Pages`	All pages in the site.
`SearchIndex`	The pre-built search index.
`Theme`	The active theme manifest.
`Versions`	All configured versions.

ApiReference

ApiReference? DocSite.ApiReference { get; init; }

The API reference model, if C# projects were analyzed.

Config

SiteConfig DocSite.Config { get; init; }

The site configuration.

CurrentVersion

DocVersion? DocSite.CurrentVersion { get; init; }

The current version being built.

NavigationTree? DocSite.Navigation { get; init; }

The navigation tree for the sidebar.

Pages

List<DocPage> DocSite.Pages { get; init; }

All pages in the site.

SearchIndex

SearchIndex? DocSite.SearchIndex { get; init; }

The pre-built search index.

Theme

ThemeManifest? DocSite.Theme { get; init; }

The active theme manifest.

Versions

List<DocVersion> DocSite.Versions { get; init; }

All configured versions.

Type Relationships

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

View Source

/// <summary>
///     Top-level model representing the entire documentation site being generated.
/// </summary>
public sealed record DocSite
{
    /// <summary>The site configuration.</summary>
    public required SiteConfig Config { get; init; }
    /// <summary>All pages in the site.</summary>
    public List<DocPage> Pages { get; init; } = [];
    /// <summary>The API reference model, if C# projects were analyzed.</summary>
    public ApiReference? ApiReference { get; init; }
    /// <summary>The navigation tree for the sidebar.</summary>
    public NavigationTree? Navigation { get; init; }
    /// <summary>The pre-built search index.</summary>
    public SearchIndex? SearchIndex { get; init; }
    /// <summary>The current version being built.</summary>
    public DocVersion? CurrentVersion { get; init; }
    /// <summary>All configured versions.</summary>
    public List<DocVersion> Versions { get; init; } = [];
    /// <summary>The active theme manifest.</summary>
    public ThemeManifest? Theme { get; init; }
}