Ox Content

search.ts

Source

resolveSearchOptions

function

Resolves search options with defaults.

Source

export function resolveSearchOptions(
  options: SearchOptions | boolean | undefined,
  ): ResolvedSearchOptions

Returns

ResolvedSearchOptions -


collectMarkdownFiles

function

Collects all Markdown files from a directory.

Source

async function collectMarkdownFiles(dir: string): Promise<string[]>

Returns

Promise<string[]> -


buildSearchIndex

function

Builds the search index from Markdown files.

Source

export async function buildSearchIndex(srcDir: string, base: string): Promise<string>

Returns

Promise<string> -


writeSearchIndex

function

Writes the search index to a file.

Source

export async function writeSearchIndex(indexJson: string, outDir: string): Promise<void>

Returns

Promise<void> -


generateSearchModule

function

Client-side search module code. This is injected into the bundle as a virtual module.

Source

export function generateSearchModule(options: ResolvedSearchOptions, indexPath: string): string

Returns

string -