@tanstack/markdown
Version:
A tiny, fast, deterministic Markdown renderer for blogs and documentation.
15 lines • 930 B
TypeScript
import type { ComponentBody, ElementDescriptor, OctaneNode } from 'octane';
import type { BlockNode, InlineNode, MarkdownInput, RenderOptions } from './types.js';
type ComponentMap = Partial<Record<string, string | ComponentBody<any>>>;
export interface MarkdownOctaneOptions extends RenderOptions {
components?: ComponentMap;
}
export interface MarkdownProps extends MarkdownOctaneOptions {
children: MarkdownInput;
}
export declare function Markdown({ children, ...options }: MarkdownProps): ElementDescriptor;
export declare function renderMarkdownOctane(input: MarkdownInput, options?: MarkdownOctaneOptions): OctaneNode[];
export declare function renderBlockOctane(node: BlockNode, options?: MarkdownOctaneOptions, key?: string): ElementDescriptor;
export declare function renderInlineOctane(node: InlineNode, options?: MarkdownOctaneOptions, key?: string): OctaneNode;
export {};
//# sourceMappingURL=octane.d.ts.map