quarkdown-html/com.quarkdown.rendering.html.post.resources/SearchIndexPostRendererResource

SearchIndexPostRendererResource

class SearchIndexPostRendererResource(index: SearchIndex) : PostRendererResource

A PostRendererResource that outputs a search index as a JSON file.

The generated search-index.json file is placed in the output directory and can be fetched by client-side JavaScript to provide documentation search without requiring a server.

Parameters

index

the search index to serialize

See also

Constructors

Link copied to clipboard
constructor(index: SearchIndex)

Functions

Link copied to clipboard
open override fun includeTo(resources: MutableSet<OutputResource>, rendered: CharSequence)

Collects resources and adds them to the output set.