Pennington.FrontMatter.DocFrontMatter

namespace Pennington.FrontMatter;

/// Core-library front matter for documentation pages on bare AddPennington hosts. Implements IFrontMatter, ITaggable, ISectionable, and IOrderable — the default capability shape for doc content without the DocSite template. Hosts using AddDocSite bind DocSiteFrontMatter from the Pennington.DocSite package instead.
public record DocFrontMatter
{
    /// Short summary used in meta descriptions, OpenGraph tags, and listings.
    
public string? Description { get; init; }

    /// True when the page is a draft and should be excluded from builds.
    
public bool IsDraft { get; init; }

    /// True when the page should be included in llms.txt output.
    
public bool Llms { get; init; } = true;

    /// Sort order for this page within its section (lower sorts first).
    
public int Order { get; init; } = int.MaxValue;

    /// True when the page should be included in the search index.
    
public bool Search { get; init; } = true;

    /// Section label for this page, used in breadcrumbs and prev/next navigation.
    
public string? SectionLabel { get; init; }

    /// Tags applied to this content.
    
public string[] Tags { get; init; } = [];

    /// Page title rendered in the browser tab, navigation, and OpenGraph tags.
    
public string Title { get; init; } = "";

    /// Stable cross-reference identifier used by xref links.
    
public string? Uid { get; init; }
}