This site provides a machine-readable index at /llms.txt.

Skip to main content Skip to navigation

ContentTocItem Pennington.Content

A table-of-contents entry for navigation.

Properties

Description string?
Default: null
Front-matter description, surfaced as a boosted field in the search index.
ExcludeFromLlms bool
Default: false
When true, excluded from llms.txt.
ExcludeFromSearch bool
Default: false
When true, excluded from the search index.
HierarchyParts string[]
Ancestor path segments used to place the entry in the tree.
Locale string?
Default: null
Locale the entry belongs to, or null when the entry is locale-neutral.
Order int
Default: 0
Sort order within the entry's section.
Route Pennington.Routing.ContentRoute
Content route the entry links to.
SectionLabel string?
Default: null
Section label used for grouping, or null for the default bucket.
Title string
Display title shown in navigation.

Constructors

.ctor

#
public record ContentTocItem(
    string Title,
    ContentRoute Route,
    int Order,
    string[] HierarchyParts,
    string? SectionLabel,
    string? Locale
)
{
    /// <summary>Front-matter description, surfaced as a boosted field in the search index.</summary>
    public string? Description { get; init; }

    /// <summary>When true, excluded from the search index.</summary>
    public bool ExcludeFromSearch { get; init; }

    /// <summary>When true, excluded from llms.txt.</summary>
    public bool ExcludeFromLlms { get; init; }
}

A table-of-contents entry for navigation.

Parameters

Title string
Display title shown in navigation.
Route ContentRoute
Content route the entry links to.
Order int
Sort order within the entry's section.
HierarchyParts string[]
Ancestor path segments used to place the entry in the tree.
SectionLabel string?
Section label used for grouping, or null for the default bucket.
Locale string?
Locale the entry belongs to, or null when the entry is locale-neutral.

Pennington.Content.ContentTocItem

namespace Pennington.Content;

/// A table-of-contents entry for navigation.
public record ContentTocItem
{
    /// A table-of-contents entry for navigation.
    
public record ContentTocItem(
    string Title,
    ContentRoute Route,
    int Order,
    string[] HierarchyParts,
    string? SectionLabel,
    string? Locale
)
{
    /// <summary>Front-matter description, surfaced as a boosted field in the search index.</summary>
    public string? Description { get; init; }

    /// <summary>When true, excluded from the search index.</summary>
    public bool ExcludeFromSearch { get; init; }

    /// <summary>When true, excluded from llms.txt.</summary>
    public bool ExcludeFromLlms { get; init; }
}
/// Front-matter description, surfaced as a boosted field in the search index.
public string? Description { get; init; }
/// When true, excluded from llms.txt.
public bool ExcludeFromLlms { get; init; }
/// When true, excluded from the search index.
public bool ExcludeFromSearch { get; init; }
/// Ancestor path segments used to place the entry in the tree.
string[] HierarchyParts
; /// Locale the entry belongs to, or null when the entry is locale-neutral.
string? Locale
; /// Sort order within the entry's section.
int Order
; /// Content route the entry links to.
ContentRoute Route
; /// Section label used for grouping, or null for the default bucket.
string? SectionLabel
; /// Display title shown in navigation.
string Title
; }