ContentTocItem Pennington.Content
A table-of-contents entry for navigation.
Properties
Descriptionstring?- Default:
nullFront-matter description, surfaced as a boosted field in the search index. ExcludeFromLlmsbool- Default:
falseWhen true, excluded from llms.txt. ExcludeFromSearchbool- Default:
falseWhen true, excluded from the search index. HierarchyPartsstring[]- Ancestor path segments used to place the entry in the tree.
Localestring?- Default:
nullLocale the entry belongs to, ornullwhen the entry is locale-neutral. Orderint- Default:
0Sort order within the entry's section. RoutePennington.Routing.ContentRoute- Content route the entry links to.
SectionLabelstring?- Default:
nullSection label used for grouping, ornullfor the default bucket. Titlestring- 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
Titlestring- Display title shown in navigation.
RouteContentRoute- Content route the entry links to.
Orderint- Sort order within the entry's section.
HierarchyPartsstring[]- Ancestor path segments used to place the entry in the tree.
SectionLabelstring?- Section label used for grouping, or
nullfor the default bucket. Localestring?- Locale the entry belongs to, or
nullwhen 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
;
}