ts-markdown/dist.browser/renderers/img.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 img elements.
 */
export interface ImageEntry extends MarkdownEntry {
    /**
     * The img settings and identifying property for the renderer.
     */
    img: {
        /**
         * The path to the image.
         */
        source: string;
        /**
         * Alternative text to include with the image for accessibility.
         */
        alt?: string;
        /**
         * A title for the image.
         */
        title?: string;
    };
}
/**
 * The renderer for img entries.
 *
 * @param entry The img entry.
 * @param options Document-level render options.
 * @returns img markdown content.
 */
export declare const imgRenderer: MarkdownRenderer;
export declare function img(settings: ImageEntry['img']): ImageEntry;