ts-markdown/dist/renderers/ul.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 unordered lists.
 */
export interface UnorderedListEntry extends MarkdownEntry {
    /**
     * The unordered list contents and identifying property for the renderer.
     */
    ul: ListItemEntry[];
    /**
     * An indicator specifying which character to use when denoting a list item.
     * Default: '-'
     */
    indicator?: UnorderedListItemIndicator;
    /**
     * Option which will arbitrarily append a string immediately below the unordered list, ignoring block-level settings.
     */
    append?: string;
}
/**
 * Eligible characters for denoting a list item.
 */
export declare type UnorderedListItemIndicator = '-' | '*' | '+';
/**
 * The renderer for unordered list entries.
 *
 * @param entry The unordered list entry.
 * @param options Document-level render options.
 * @returns Block-level unordered list markdown content.
 */
export declare const ulRenderer: MarkdownRenderer;
/**
 * Helper which creates an unordered list entry.
 *
 * @param options Entry-level options for this element.
 * @returns an unordered list entry
 */
export declare function ul(content: UnorderedListEntry['ul'], options?: Omit<UnorderedListEntry, 'ul'>): UnorderedListEntry;