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

Namespace: Moka.Docs.Core.Configuration

Theme-specific options for customizing appearance.

Inheritance

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

Properties

NameDescription
AccentColor Accent color for highlights.
CodeStyle Code block window style: "plain", "macos", "terminal", or "vscode".
CodeStyleSelector Show code block style selector in the header.
CodeTheme Code syntax highlighting theme.
CodeThemeSelector Show code syntax theme selector in the header.
ColorThemes Show color theme preset selector in the header.
DefaultColorTheme Default color theme applied on first visit (before localStorage is set). Supported values: ocean, emerald, violet, amber, rose, moka-red. Defaults to ocean.
PrimaryColor Primary brand color.
ShowAnimations Show page animations (fade-in, slide-up, etc).
ShowBackToTop Show the back-to-top button.
ShowBreadcrumbs Show breadcrumb navigation.
ShowBuiltWith Show "Built with MokaDocs" branding and version in the footer. Default is true.
ShowContributors Show contributor avatars on pages.
ShowCopyButton Show copy button on code blocks.
ShowDarkModeToggle Show the dark/light mode toggle.
ShowEditLink Show "Edit this page" link on each page.
ShowFeedback Show the "Was this page helpful?" feedback widget.
ShowLastUpdated Show last-updated timestamp on pages.
ShowLineNumbers Show line numbers on code blocks.
ShowPrevNext Show Previous/Next navigation at bottom of pages.
ShowSearch Show the search bar and Ctrl+K shortcut.
ShowTableOfContents Show the table of contents sidebar.
ShowVersionSelector Show the version selector dropdown.
SocialLinks Social links displayed in the site header.
TocDepth Maximum heading level shown in the table of contents (2–6). Default is 3 (h2 + h3).

AccentColor

string ThemeOptions.AccentColor { get; init; }

Accent color for highlights.

CodeStyle

string ThemeOptions.CodeStyle { get; init; }

Code block window style: "plain", "macos", "terminal", or "vscode".

CodeStyleSelector

bool ThemeOptions.CodeStyleSelector { get; init; }

Show code block style selector in the header.

CodeTheme

string ThemeOptions.CodeTheme { get; init; }

Code syntax highlighting theme.

CodeThemeSelector

bool ThemeOptions.CodeThemeSelector { get; init; }

Show code syntax theme selector in the header.

ColorThemes

bool ThemeOptions.ColorThemes { get; init; }

Show color theme preset selector in the header.

DefaultColorTheme

string ThemeOptions.DefaultColorTheme { get; init; }

Default color theme applied on first visit (before localStorage is set). Supported values: ocean, emerald, violet, amber, rose, moka-red. Defaults to ocean.

PrimaryColor

string ThemeOptions.PrimaryColor { get; init; }

Primary brand color.

ShowAnimations

bool ThemeOptions.ShowAnimations { get; init; }

Show page animations (fade-in, slide-up, etc).

ShowBackToTop

bool ThemeOptions.ShowBackToTop { get; init; }

Show the back-to-top button.

ShowBreadcrumbs

bool ThemeOptions.ShowBreadcrumbs { get; init; }

Show breadcrumb navigation.

ShowBuiltWith

bool ThemeOptions.ShowBuiltWith { get; init; }

Show "Built with MokaDocs" branding and version in the footer. Default is true.

ShowContributors

bool ThemeOptions.ShowContributors { get; init; }

Show contributor avatars on pages.

ShowCopyButton

bool ThemeOptions.ShowCopyButton { get; init; }

Show copy button on code blocks.

ShowDarkModeToggle

bool ThemeOptions.ShowDarkModeToggle { get; init; }

Show the dark/light mode toggle.

bool ThemeOptions.ShowEditLink { get; init; }

Show "Edit this page" link on each page.

ShowFeedback

bool ThemeOptions.ShowFeedback { get; init; }

Show the "Was this page helpful?" feedback widget.

ShowLastUpdated

bool ThemeOptions.ShowLastUpdated { get; init; }

Show last-updated timestamp on pages.

ShowLineNumbers

bool ThemeOptions.ShowLineNumbers { get; init; }

Show line numbers on code blocks.

ShowPrevNext

bool ThemeOptions.ShowPrevNext { get; init; }

Show Previous/Next navigation at bottom of pages.

ShowSearch

bool ThemeOptions.ShowSearch { get; init; }

Show the search bar and Ctrl+K shortcut.

ShowTableOfContents

bool ThemeOptions.ShowTableOfContents { get; init; }

Show the table of contents sidebar.

ShowVersionSelector

bool ThemeOptions.ShowVersionSelector { get; init; }

Show the version selector dropdown.

List<SocialLink> ThemeOptions.SocialLinks { get; init; }

Social links displayed in the site header.

TocDepth

int ThemeOptions.TocDepth { get; init; }

Maximum heading level shown in the table of contents (2–6). Default is 3 (h2 + h3).

Type Relationships
classDiagram
                    style ThemeOptions fill:#f9f,stroke:#333,stroke-width:2px
                    ThemeOptions ..|> ThemeOptions~ : implements
                
View Source
/// <summary>
///     Theme-specific options for customizing appearance.
/// </summary>
public sealed record ThemeOptions
{
    /// <summary>Primary brand color.</summary>
    public string PrimaryColor { get; init; } = MokaDefaults.PrimaryColor;
    /// <summary>Accent color for highlights.</summary>
    public string AccentColor { get; init; } = "#f59e0b";
    /// <summary>Code syntax highlighting theme.</summary>
    public string CodeTheme { get; init; } = MokaDefaults.CodeTheme;
    /// <summary>Show "Edit this page" link on each page.</summary>
    public bool ShowEditLink { get; init; } = MokaDefaults.ShowEditLink;
    /// <summary>Show last-updated timestamp on pages.</summary>
    public bool ShowLastUpdated { get; init; } = MokaDefaults.ShowLastUpdated;
    /// <summary>Show contributor avatars on pages.</summary>
    public bool ShowContributors { get; init; }
    /// <summary>Show color theme preset selector in the header.</summary>
    public bool ColorThemes { get; init; } = MokaDefaults.ShowColorThemeSelector;
    /// <summary>Show code syntax theme selector in the header.</summary>
    public bool CodeThemeSelector { get; init; } = MokaDefaults.ShowCodeThemeSelector;
    /// <summary>Code block window style: "plain", "macos", "terminal", or "vscode".</summary>
    public string CodeStyle { get; init; } = MokaDefaults.CodeStyle;
    /// <summary>Show code block style selector in the header.</summary>
    public bool CodeStyleSelector { get; init; } = MokaDefaults.ShowCodeStyleSelector;
    /// <summary>Show the "Was this page helpful?" feedback widget.</summary>
    public bool ShowFeedback { get; init; } = MokaDefaults.ShowFeedbackWidget;
    /// <summary>Show the dark/light mode toggle.</summary>
    public bool ShowDarkModeToggle { get; init; } = MokaDefaults.ShowDarkModeToggle;
    /// <summary>Show page animations (fade-in, slide-up, etc).</summary>
    public bool ShowAnimations { get; init; } = MokaDefaults.ShowAnimations;
    /// <summary>Show the search bar and Ctrl+K shortcut.</summary>
    public bool ShowSearch { get; init; } = MokaDefaults.ShowSearch;
    /// <summary>Show the table of contents sidebar.</summary>
    public bool ShowTableOfContents { get; init; } = MokaDefaults.ShowTableOfContents;
    /// <summary>Show Previous/Next navigation at bottom of pages.</summary>
    public bool ShowPrevNext { get; init; } = MokaDefaults.ShowPrevNext;
    /// <summary>Show breadcrumb navigation.</summary>
    public bool ShowBreadcrumbs { get; init; } = MokaDefaults.ShowBreadcrumbs;
    /// <summary>Show the back-to-top button.</summary>
    public bool ShowBackToTop { get; init; } = MokaDefaults.ShowBackToTop;
    /// <summary>Show copy button on code blocks.</summary>
    public bool ShowCopyButton { get; init; } = MokaDefaults.ShowCopyButton;
    /// <summary>Show line numbers on code blocks.</summary>
    public bool ShowLineNumbers { get; init; } = MokaDefaults.ShowLineNumbers;
    /// <summary>Maximum heading level shown in the table of contents (2–6). Default is 3 (h2 + h3).</summary>
    public int TocDepth { get; init; } = MokaDefaults.TocDepth;
    /// <summary>Show the version selector dropdown.</summary>
    public bool ShowVersionSelector { get; init; } = MokaDefaults.ShowVersionSelector;
    /// <summary>Show "Built with MokaDocs" branding and version in the footer. Default is true.</summary>
    public bool ShowBuiltWith { get; init; } = MokaDefaults.ShowBuiltWith;
    /// <summary>Social links displayed in the site header.</summary>
    public List<SocialLink> SocialLinks { get; init; } = [];
    /// <summary>
    ///     Default color theme applied on first visit (before localStorage is set).
    ///     Supported values: <c>ocean</c>, <c>emerald</c>, <c>violet</c>, <c>amber</c>,
    ///     <c>rose</c>, <c>moka-red</c>. Defaults to <c>ocean</c>.
    /// </summary>
    public string DefaultColorTheme { get; init; } = "ocean";
}
Was this page helpful?