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; set; }


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


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


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


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


    /// When true, the page is included in indexing channels (search, llms.txt) but excluded from the rendered navigation tree. Useful for FAQ entries, glossary terms, or other content that should be discoverable by search but should not clutter the sidebar.
    
public bool SearchOnly { get; set; }


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


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


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


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

}