BuildConfig

Home
API Reference
Moka
Docs
Core
Configuration
BuildConfig

Record

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

Namespace: Moka.Docs.Core.Configuration

Build options.

Inheritance

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

Properties

Name	Description
`BasePath`	Base path for the generated site when deployed to a subdirectory. For example, "/Moka.Docs" for GitHub Pages at https://user.github.io/Moka.Docs/. Defaults to "/" (site root).
`Cache`	Cache intermediate results for faster rebuilds.
`Clean`	Clean output directory before build.
`Minify`	Minify HTML/CSS/JS in output.
`Output`	Output directory path.
`Robots`	Generate robots.txt.
`Sitemap`	Generate sitemap.xml.

BasePath

string BuildConfig.BasePath { get; init; }

Base path for the generated site when deployed to a subdirectory. For example, "/Moka.Docs" for GitHub Pages at https://user.github.io/Moka.Docs/. Defaults to "/" (site root).

Cache

bool BuildConfig.Cache { get; init; }

Cache intermediate results for faster rebuilds.

Clean

bool BuildConfig.Clean { get; init; }

Clean output directory before build.

Minify

bool BuildConfig.Minify { get; init; }

Minify HTML/CSS/JS in output.

Output

string BuildConfig.Output { get; init; }

Output directory path.

Robots

bool BuildConfig.Robots { get; init; }

Generate robots.txt.

Sitemap

bool BuildConfig.Sitemap { get; init; }

Generate sitemap.xml.

Type Relationships

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

View Source

/// <summary>Build options.</summary>
public sealed record BuildConfig
{
    /// <summary>Output directory path.</summary>
    public string Output { get; init; } = "./_site";
    /// <summary>Clean output directory before build.</summary>
    public bool Clean { get; init; } = MokaDefaults.CleanOutput;
    /// <summary>Minify HTML/CSS/JS in output.</summary>
    public bool Minify { get; init; } = true;
    /// <summary>Generate sitemap.xml.</summary>
    public bool Sitemap { get; init; } = MokaDefaults.GenerateSitemap;
    /// <summary>Generate robots.txt.</summary>
    public bool Robots { get; init; } = MokaDefaults.GenerateRobots;
    /// <summary>Cache intermediate results for faster rebuilds.</summary>
    public bool Cache { get; init; } = true;
    /// <summary>
    ///     Base path for the generated site when deployed to a subdirectory.
    ///     For example, "/Moka.Docs" for GitHub Pages at https://user.github.io/Moka.Docs/.
    ///     Defaults to "/" (site root).
    /// </summary>
    public string BasePath { get; init; } = "/";
}