Pennington.DocSite.DocSiteFrontMatter

namespace Pennington.DocSite;

/// Front matter bound by AddDocSite. Extends the DocFrontMatter shape with RedirectUrl via IRedirectable. Implements IFrontMatter, ITaggable, ISectionable, IOrderable, IRedirectable, and IHasStructuredData (emits a schema.org Article).
public record DocSiteFrontMatter
{
    /// Short description used for the meta description and social cards.
    
public string Description { get; set; }


    /// Returns the schema.org entities to emit on the page. Implementations typically yield one Article/Recipe/Product/etc. built from front matter values, plus the CanonicalUrl the template supplies.
    
public IEnumerable<JsonLdEntity> GetStructuredData(StructuredDataContext context)
;

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


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


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


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


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


    /// When true, the page is indexed for search/llms but hidden from the rendered navigation tree.
    
public bool SearchOnly { get; set; }


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


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


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


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

}