Pennington.Content.ContentTocItem

namespace Pennington.Content;

/// A table-of-contents entry for navigation.
public record ContentTocItem
{
    /// A table-of-contents entry for navigation.
    
public ContentTocItem(string Title, ContentRoute Route, int Order, string[] HierarchyParts, string SectionLabel, string Locale)
;

    /// Front-matter description, surfaced as a boosted field in the search index.
    
public string Description { get; set; }


    /// When true, excluded from llms.txt.
    
public bool ExcludeFromLlms { get; set; }


    /// When true, excluded from the search index.
    
public bool ExcludeFromSearch { get; set; }


    /// Ancestor path segments used to place the entry in the tree.
    
public string[] HierarchyParts { get; set; }


    /// Locale the entry belongs to, or null when the entry is locale-neutral.
    
public string Locale { get; set; }


    /// Sort order within the entry's section.
    
public int Order { get; set; }


    /// Content route the entry links to.
    
public ContentRoute Route { get; set; }


    /// When true, the entry is indexed for search/llms but filtered out of the rendered navigation tree by BuildTreeAsync. Search-index and llms.txt consumers keep the entry as long as ExcludeFromSearch / ExcludeFromLlms allow it.
    
public bool SearchOnly { get; set; }


    /// Section label used for grouping, or null for the default bucket.
    
public string SectionLabel { get; set; }


    /// Front-matter tags, surfaced as a search facet. Empty when the front matter is not ITaggable.
    
public string[] Tags { get; set; }


    /// Display title shown in navigation.
    
public string Title { get; set; }

}