Structure
SearchIndexBuilder
Builds a search index for client-side documentation search.
struct SearchIndexBuilderOverview
This type generates a JSON search index that can be loaded by Lunr.js for fast client-side full-text search.
Topics
Structures
S
SearchIndexBuilder.SearchDocument
A searchable document entry.
S
SearchIndexBuilder.SearchIndex
The complete search index.
Initializers
?
init(configuration:)
Creates a new search index builder.
Instance Properties
V
configuration
The configuration for index building.
V
index
Returns the complete search index.
Instance Methods
F
addToIndex(_:)
Adds a render node to the search index.
F
writeIndex(to:)
Writes the search index to a file.