DocShell.Presentation.SiteSearchEntry (DocShell v0.5.0)

Copy Markdown View Source

Represents one page or heading in the portable site search corpus.

Records retain the route and public filter dimensions needed by a browser or build-time indexer. They contain plain text rather than rendered markup, so a JSON adapter, Pagefind adapter, hosted search process, or test reference query can consume the same admitted corpus.

Summary

Types

t()

A deterministic search record and its public filter dimensions.

Types

t()

@type t() :: %DocShell.Presentation.SiteSearchEntry{
  audience: String.t() | [String.t()] | nil,
  collection: String.t(),
  id: String.t(),
  kind: String.t(),
  locale: String.t(),
  page_id: String.t(),
  route: String.t(),
  section: String.t() | nil,
  status: String.t() | nil,
  tags: [String.t()],
  text: String.t(),
  title: String.t(),
  version: String.t()
}

A deterministic search record and its public filter dimensions.