buildSearchIndex(srcDir: string, base: string, extensions: readonly string[] = DEFAULT_MARKDOWN_EXTENSIONS): Promise<string>Builds the search index from Markdown files.Builds the search index from Markdown files.
export async function buildSearchIndex(srcDir: string, base: string, extensions: readonly string[] = DEFAULT_MARKDOWN_EXTENSIONS): Promise<string>srcDir
string
base
string
extensions
readonly string[]
optional · default: DEFAULTMARKDOWNEXTENSIONS
Promise<string>
generateSearchModule(options: ResolvedSearchOptions, indexPath: string): stringClient-side search module code. This is injected into the bundle as a virtual m…Client-side search module code. This is injected into the bundle as a virtual module.
export function generateSearchModule(options: ResolvedSearchOptions, indexPath: string): stringoptions
ResolvedSearchOptions
indexPath
string
string
getSearchDocumentScopes(doc: Pick<SearchDocument, "id" | "url">): string[]Derives hierarchical search scopes from a document id or URL. For example, api/…Derives hierarchical search scopes from a document id or URL.
For example, api/math/index yields ["api", "api/math"].
export function getSearchDocumentScopes(doc: Pick<SearchDocument, "id" | "url">): string[]doc
Pick<SearchDocument, "id" | "url">
string[]
matchesSearchScopes(doc: Pick<SearchDocument, "id" | "url">, scopes: string[]): booleanReturns true when a search document belongs to at least one requested scope.Returns true when a search document belongs to at least one requested scope.
export function matchesSearchScopes(doc: Pick<SearchDocument, "id" | "url">, scopes: string[]): booleandoc
Pick<SearchDocument, "id" | "url">
scopes
string[]
boolean
parseScopedSearchQuery(query: string): ScopedSearchQuerySplits a raw query into free-text terms and @scope prefixes.Splits a raw query into free-text terms and @scope prefixes.
export function parseScopedSearchQuery(query: string): ScopedSearchQueryquery
string
resolveSearchOptions(options: SearchOptions | boolean | undefined): ResolvedSearchOptionsResolves search options with defaults.Resolves search options with defaults.
export function resolveSearchOptions(options: SearchOptions | boolean | undefined): ResolvedSearchOptionsoptions
SearchOptions | boolean | undefined
searchFull-text search functionality for Ox Content. Generates search index at build time and provides client-side search.Full-text search functionality for Ox Content.
Generates search index at build time and provides client-side search.
writeSearchIndex(indexJson: string, outDir: string): Promise<void>Writes the search index to a file.Writes the search index to a file.
export async function writeSearchIndex(indexJson: string, outDir: string): Promise<void>indexJson
string
outDir
string
Promise<void>