ts-markdown-builder/dist/types/html.d.ts

Elegant markdown builder with minimal bundle size.

/**
 * Create a line break.
 *
 * Markdown (as HTML): `<br/>`
 */
export declare const lineBreak = "<br/>";
/**
 * Options for the `disclosure` block.
 */
export type DisclosureOptions = {
    /**
     * Whether the disclosure block should be open by default (defaults to false).
     */
    open?: boolean;
};
/**
 * Create a disclosure block.
 *
 * Markdown (as HTML):
 * ```
 * <details>
 *   <summary>Title</summary>
 *   Content
 * </details>
 * ```
 *
 * @param title - The title of the disclosure (text only or markdown heading: `# heading`).
 * @param content - The content of the disclosure (can include markdown).
 * @param options - The options for the disclosure.
 */
export declare function disclosure(title: string, content: string, options?: DisclosureOptions): string;