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

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

import { MarkdownRenderer } from '../rendering.types';
import { MarkdownEntry } from '../shared.types';
/**
 * A markdown entry for generating a code segment.
 */
export interface CodeEntry extends MarkdownEntry {
    /**
     * The code text.
     */
    code: string;
}
/**
 * The renderer for code entries.
 *
 * @param entry The code entry.
 * @param options Document-level render options.
 * @returns Code markdown content.
 */
export declare const codeRenderer: MarkdownRenderer;
/**
 * Helper which creates a code segment entry.
 *
 * @param options Entry-level options for this element.
 * @returns a code segment entry
 */
export declare function code(content: CodeEntry['code'], options?: Omit<CodeEntry, 'code'>): CodeEntry;