ts-markdown/dist/renderers/h6.d.ts

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

import { MarkdownRenderer } from '../rendering.types';
import { InlineTypes, MarkdownEntry } from '../shared.types';
/**
 * A markdown entry for generating h6 elements.
 */
export interface H6Entry extends MarkdownEntry {
    /**
     * The h6 contents and identifying property for the renderer.
     */
    h6: InlineTypes;
    /**
     * Option which will append a markdown heading ID.
     * E.g., given the ID 'my-id' and the header 'Header Example',
     * `###### Header Example {#my-id}`
     */
    id?: string;
    /**
     * Option which will arbitrarily append a string immediately below the h6, ignoring block-level settings.
     */
    append?: string;
}
/**
 * The renderer for h6 entries.
 *
 * @param entry The h6 entry.
 * @param options Document-level render options.
 * @returns Block-level h6 markdown content.
 */
export declare const h6Renderer: MarkdownRenderer;
/**
 * Helper which creates a sixth-level header entry.
 *
 * @param options Entry-level options for this element.
 * @returns a sixth-level header entry
 */
export declare function h6(content: H6Entry['h6'], options?: Omit<H6Entry, 'h6'>): H6Entry;