Record
public record TableOfContents : System.IEquatable<Moka.Docs.Core.Content.TableOfContents>

Namespace: Moka.Docs.Core.Content

Auto-generated table of contents from page headings.

Inheritance

Implements: System.IEquatable<Moka.Docs.Core.Content.TableOfContents>

Properties

NameDescription
Empty static Empty table of contents.
Entries The heading entries in order.

Empty

TableOfContents TableOfContents.Empty { get; }

Empty table of contents.

Entries

IReadOnlyList<TocEntry> TableOfContents.Entries { get; init; }

The heading entries in order.

Type Relationships
classDiagram
                    style TableOfContents fill:#f9f,stroke:#333,stroke-width:2px
                    TableOfContents ..|> TableOfContents~ : implements
                
View Source
/// <summary>
///     Auto-generated table of contents from page headings.
/// </summary>
public sealed record TableOfContents
{
    /// <summary>The heading entries in order.</summary>
    public IReadOnlyList<TocEntry> Entries { get; init; } = [];
    /// <summary>Empty table of contents.</summary>
    public static TableOfContents Empty => new();
}
Was this page helpful?