fumadocs-core
Version:
The React.js library for building a documentation website
28 lines (27 loc) • 764 B
TypeScript
import { ReactNode } from "react";
//#region src/search/index.d.ts
interface SortedResult<Content = string> {
id: string;
url: string;
type: 'page' | 'heading' | 'text';
content: Content;
/**
* breadcrumbs to be displayed on UI
*/
breadcrumbs?: Content[];
contentWithHighlights?: HighlightedText<Content>[];
}
type ReactSortedResult = SortedResult<ReactNode>;
interface HighlightedText<Content = string> {
type: 'text';
content: Content;
styles?: {
highlight?: boolean;
};
}
declare function createContentHighlighter(query: string | RegExp): {
highlight(content: string): HighlightedText[];
};
//#endregion
export { HighlightedText, ReactSortedResult, SortedResult, createContentHighlighter };
//# sourceMappingURL=index.d.ts.map