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

Elegant markdown builder with minimal bundle size.

/**
 * Create a horizontal rule block.
 *
 * Markdown: `---`
 */
export declare const horizontalRule = "---";
type HeadingOptions = {
    level: number;
};
/**
 * Create a heading block.
 * Markdown: `# Heading`
 *
 * @param text - The text of the heading.
 * @param level - The level of the heading (defaults to 1).
 */
export declare function heading(text: string, options?: HeadingOptions): string;
/**
 * Create a blockquote block.
 *
 * Markdown:
 * ```
 * > Content
 * > Content
 * ```
 *
 * @param text - The content of the blockquote.
 */
export declare function blockquote(content: string | readonly string[]): string;
/**
 * Create a code block.
 *
 * Markdown:
 * ```
 * Content
 * ```
 *
 * @param content - The content of the code block.
 */
export declare function codeBlock(content: string): string;
/**
 * Create an unordered list block.
 *
 * Markdown:
 * ```
 * - Item
 * - Item
 * ```
 *
 * @param items - The items of the list.
 */
export declare function list(items: readonly string[]): string;
/**
 * Create an ordered list block.
 *
 * Markdown:
 * ```
 * 1. Item
 * 2. Item
 * ```
 *
 * @param items - The items of the list.
 */
export declare function orderedList(items: readonly string[]): string;
export {};