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

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

import { MarkdownRenderer } from '../rendering.types';
import { RichTextEntry, MarkdownEntry } from '../shared.types';
/**
 * A markdown entry for generating superscript text.
 */
export interface SuperscriptEntry extends MarkdownEntry, RichTextEntry {
    /**
     * The superscript contents and identifying property for the renderer.
     */
    sup: RichTextEntry;
    /**
     * Option to render the superscript indicators as HTML.
     * Default: false
     */
    html?: boolean;
}
/**
 * The renderer for superscript entries.
 *
 * @param entry The superscript entry.
 * @param options Document-level render options.
 * @returns Superscript markdown content.
 */
export declare const supRenderer: MarkdownRenderer;
/**
 * Helper which creates a superscript text entry.
 *
 * @param options Entry-level options for this element.
 * @returns a superscript text entry
 */
export declare function sup(content: SuperscriptEntry['sup'], options?: Omit<SuperscriptEntry, 'sup'>): SuperscriptEntry;