UNPKG

@humanspeak/svelte-markdown

Version:

A powerful, customizable markdown renderer for Svelte with TypeScript support

30 lines (29 loc) 1.21 kB
import { type SvelteMarkdownProps } from './types.js'; type $$ComponentProps = SvelteMarkdownProps & { [key: string]: unknown; }; /** * A Svelte component that renders Markdown content into HTML using a customizable parser. * Supports both string input and pre-parsed markdown tokens, with configurable rendering * options and custom renderers. * * @example * ```svelte * <SvelteMarkdown source="# Hello World" /> * * <SvelteMarkdown * source={markdownString} * options={{ headerIds: false }} * renderers={{ link: CustomLink }} * /> * ``` * * @property {string | Token[]} source - The markdown content to render, either as a string or pre-parsed tokens * @property {Partial<Renderers>} [renderers] - Custom renderers for markdown elements * @property {SvelteMarkdownOptions} [options] - Configuration options for the markdown parser * @property {boolean} [isInline=false] - Whether to parse the content as inline markdown * @property {function} [parsed] - Callback function called with the parsed tokens */ declare const SvelteMarkdown: import("svelte").Component<$$ComponentProps, {}, "">; type SvelteMarkdown = ReturnType<typeof SvelteMarkdown>; export default SvelteMarkdown;