ts-markdown-parser/dist/index.d.ts

TypeScript library that converts markdown to HTML (with code support).

type MarkdownToHtmlOptions = {
    addCopyToClipboard?: boolean;
    interactiveCheckboxes?: boolean;
};
/**
 * Converts a Markdown string into an HTML string.
 *
 * @param {string} markdown - The Markdown content to be converted to HTML.
 * @param {boolean|MarkdownToHtmlOptions} opts - Adds "Copy" button to HTML `<code>` blocks (legacy) or options object.
 * @returns {string} The resulting HTML content.
 */
export declare const markdownToHtml: (markdown: string, opts?: boolean | MarkdownToHtmlOptions) => string;
/**
 * Extracts metadata from a Markdown string.
 *
 * This function extracts and parses the YAML front matter from the Markdown content,
 * returning it as a JavaScript object.
 *
 * @param {string} markdown - The Markdown content from which to extract metadata.
 * @returns {Record<string, any>} An object containing the metadata extracted from the Markdown.
 *
 * @example
 * const markdown = `
 * ---
 * title: "Example Article"
 * author: "Author Name"
 * date: "2024-08-21"
 * ---
 * # Hello World
 * This is a test.
 * `;
 * const metadata = getMarkdownMetadata(markdown);
 * console.log(metadata); // Outputs the metadata object
 */
export declare const getMarkdownMetadata: (markdown: string) => Record<string, any>;
export {};
//# sourceMappingURL=index.d.ts.map