FrontMatter

Home
API Reference
Moka
Docs
Core
Content
FrontMatter

Record

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

Namespace: Moka.Docs.Core.Content

Front matter metadata extracted from YAML at the top of a Markdown file.

Inheritance

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

Properties

Name	Description
`Description`	Page description for meta tags.
`Expanded`	Whether this section is expanded in the sidebar by default.
`Icon`	Icon name for sidebar display.
`Layout`	Layout template to use.
`Order`	Sort order within its parent section.
`Requires`	Feature flag required for this page to be included in the build.
`Route`	Custom URL slug override.
`Tags`	Tags for categorization and search.
`Title`	Page title.
`Toc`	Whether to show a table of contents.
`Version`	Version range this page applies to (e.g., ">=2.0").
`Visibility`	Page visibility.

Description

string FrontMatter.Description { get; init; }

Page description for meta tags.

Expanded

bool FrontMatter.Expanded { get; init; }

Whether this section is expanded in the sidebar by default.

Icon

string? FrontMatter.Icon { get; init; }

Icon name for sidebar display.

Layout

string FrontMatter.Layout { get; init; }

Layout template to use.

Order

int FrontMatter.Order { get; init; }

Sort order within its parent section.

Requires

string? FrontMatter.Requires { get; init; }

Feature flag required for this page to be included in the build.

Route

string? FrontMatter.Route { get; init; }

Custom URL slug override.

Title

string FrontMatter.Title { get; init; }

Page title.

Version

string? FrontMatter.Version { get; init; }

Version range this page applies to (e.g., ">=2.0").

Visibility

PageVisibility FrontMatter.Visibility { get; init; }

Page visibility.

Type Relationships

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

View Source

/// <summary>
///     Front matter metadata extracted from YAML at the top of a Markdown file.
/// </summary>
public sealed record FrontMatter
{
    /// <summary>Page title.</summary>
    public required string Title { get; init; }
    /// <summary>Page description for meta tags.</summary>
    public string Description { get; init; } = "";
    /// <summary>Sort order within its parent section.</summary>
    public int Order { get; init; }
    /// <summary>Icon name for sidebar display.</summary>
    public string? Icon { get; init; }
    /// <summary>Layout template to use.</summary>
    public string Layout { get; init; } = "default";
    /// <summary>Tags for categorization and search.</summary>
    public List<string> Tags { get; init; } = [];
    /// <summary>Page visibility.</summary>
    public PageVisibility Visibility { get; init; } = PageVisibility.Public;
    /// <summary>Whether to show a table of contents.</summary>
    public bool Toc { get; init; } = true;
    /// <summary>Whether this section is expanded in the sidebar by default.</summary>
    public bool Expanded { get; init; } = true;
    /// <summary>Custom URL slug override.</summary>
    public string? Route { get; init; }
    /// <summary>Version range this page applies to (e.g., ">=2.0").</summary>
    public string? Version { get; init; }
    /// <summary>Feature flag required for this page to be included in the build.</summary>
    public string? Requires { get; init; }
}