UNPKG

ts-markdown

Version:

An extensible TypeScript markdown generator that takes JSON and creates a markdown document.

25 lines (24 loc) 841 B
import { MarkdownRenderer } from '../rendering.types'; import { InlineTypes, MarkdownEntry } from '../shared.types'; /** * A markdown entry for generating paragraphs. */ export interface ParagraphEntry extends MarkdownEntry { /** * The paragraph contents and identifying property for the renderer. */ p: InlineTypes; /** * Option which will arbitrarily append a string immediately below the paragraph, ignoring block-level settings. */ append?: string; } /** * The renderer for paragraph entries. * * @param entry The paragraph entry. * @param options Document-level render options. * @returns Block-level paragraph markdown content. */ export declare const pRenderer: MarkdownRenderer; export declare function p(content: ParagraphEntry['p'], options?: Omit<ParagraphEntry, 'p'>): ParagraphEntry;