DocSiteFrontMatter Pennington.DocSite

Front matter bound by AddDocSite. Extends the DocFrontMatter shape with RedirectUrl via IRedirectable. Implements IFrontMatter, ITaggable, ISectionable, IOrderable, and IRedirectable.

Properties

Description string?: Default: null
Short description used for the meta description and social cards.
IsDraft bool: Default: false
When true, the page is skipped during production builds.
Llms bool: Default: true
When false, the page is excluded from the generated llms.txt output.
Order int: Default: int.MaxValue
Sort order within the containing section. Lower values appear first.
RedirectUrl string?: Default: null
When set, the page emits a client-side redirect to this URL instead of normal content.
Search bool: Default: true
When false, the page is excluded from the search index.
SectionLabel string?: Default: null
Section heading this page belongs under in navigation.
Tags string[]: Default: []
Tags applied to this page for filtering and the tag index.
Title string: Default: ""
Page title rendered in the browser tab and page heading.
Uid string?: Default: null
Stable identifier used for cross-references ([text](xref:uid)).

Pennington.DocSite.DocSiteFrontMatter

namespace Pennington.DocSite;

/// Front matter bound by AddDocSite. Extends the DocFrontMatter shape with RedirectUrl via IRedirectable. Implements IFrontMatter, ITaggable, ISectionable, IOrderable, and IRedirectable.
public record DocSiteFrontMatter
{
    /// Short description used for the meta description and social cards.
    public string? Description { get; init; }

    /// When true, the page is skipped during production builds.
    public bool IsDraft { get; init; }

    /// When false, the page is excluded from the generated llms.txt output.
    public bool Llms { get; init; } = true;

    /// Sort order within the containing section. Lower values appear first.
    public int Order { get; init; } = int.MaxValue;

    /// When set, the page emits a client-side redirect to this URL instead of normal content.
    public string? RedirectUrl { get; init; }

    /// When false, the page is excluded from the search index.
    public bool Search { get; init; } = true;

    /// Section heading this page belongs under in navigation.
    public string? SectionLabel { get; init; }

    /// Tags applied to this page for filtering and the tag index.
    public string[] Tags { get; init; } = [];

    /// Page title rendered in the browser tab and page heading.
    public string Title { get; init; } = "";

    /// Stable identifier used for cross-references ([text](xref:uid)).
    public string? Uid { get; init; }
}