quarkdown-html/com.quarkdown.rendering.html.search

Package-level declarations

Types

@Serializable

data class SearchEntry(val url: String, val title: String?, val description: String?, val keywords: List<String>, val content: String, val headings: List<SearchHeading>)

A searchable document entry in the search index.

SearchHeading

@Serializable

data class SearchHeading(val anchor: String, val text: String, val level: Int)

A heading within a document, enabling search results to link directly to sections.

SearchIndex

@Serializable

data class SearchIndex(val entries: List<SearchEntry>)

A search index for client-side documentation search. This structure is serialized to JSON and loaded by the browser to provide search functionality without a server.

SearchIndexGenerator

object SearchIndexGenerator

Generates a SearchIndex from the subdocument graph of a multi-document project. The generated index is intended to be serialized to JSON and used for client-side search.