SearchEntry

Home
API Reference
Moka
Docs
Core
Search
SearchEntry

Record

public record SearchEntry : System.IEquatable<Moka.Docs.Core.Search.SearchEntry>

Namespace: Moka.Docs.Core.Search

A single searchable entry in the index.

Inheritance

Implements: System.IEquatable<Moka.Docs.Core.Search.SearchEntry>

Properties

Name	Description
`Category`	Category for grouping results (e.g., "Documentation", "API Reference").
`Content`	Text content snippet for matching and display.
`Route`	URL route to navigate to.
`Section`	The section heading (if this entry is for a specific section).
`Tags`	Tags for additional matching.
`Title`	The page title.

Content

string SearchEntry.Content { get; init; }

Text content snippet for matching and display.

Route

string SearchEntry.Route { get; init; }

URL route to navigate to.

Section

string? SearchEntry.Section { get; init; }

The section heading (if this entry is for a specific section).

Title

string SearchEntry.Title { get; init; }

The page title.

Type Relationships

classDiagram
                    style SearchEntry fill:#f9f,stroke:#333,stroke-width:2px
                    SearchEntry ..|> SearchEntry~ : implements

View Source

/// <summary>
///     A single searchable entry in the index.
/// </summary>
public sealed record SearchEntry
{
    /// <summary>The page title.</summary>
    public required string Title { get; init; }
    /// <summary>The section heading (if this entry is for a specific section).</summary>
    public string? Section { get; init; }
    /// <summary>URL route to navigate to.</summary>
    public required string Route { get; init; }
    /// <summary>Text content snippet for matching and display.</summary>
    public required string Content { get; init; }
    /// <summary>Category for grouping results (e.g., "Documentation", "API Reference").</summary>
    public string Category { get; init; } = "Documentation";
    /// <summary>Tags for additional matching.</summary>
    public List<string> Tags { get; init; } = [];
}