ts-markdown/dist.browser/renderers/ol.d.ts

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

import { MarkdownRenderer } from '../rendering.types';
import { ListItemEntry, MarkdownEntry } from '../shared.types';
/**
 * A markdown entry for generating ordered lists.
 */
export interface OrderedListEntry extends MarkdownEntry {
    /**
     * The ordered list contetns and identifying property for the renderer.
     */
    ol: ListItemEntry[];
    /**
     * Option which will arbitrarily append a string immediately below the ordered list, ignoring block-level settings.
     */
    append?: string;
}
/**
 * The renderer for ordered list entries.
 *
 * @param entry The ordererd list entry.
 * @param options Document-level render options.
 * @returns Block-level ordered list markdown content.
 */
export declare const olRenderer: MarkdownRenderer;
/**
 * Helper which creates an ordered list entry.
 *
 * @param options Entry-level options for this element.
 * @returns an ordered list entry
 */
export declare function ol(content: OrderedListEntry['ol'], options?: Omit<OrderedListEntry, 'ol'>): OrderedListEntry;