ts-markdown
Version:
An extensible TypeScript markdown generator that takes JSON and creates a markdown document.
26 lines (25 loc) • 835 B
TypeScript
import { MarkdownRenderer } from '../rendering.types';
import { RichTextEntry, MarkdownEntry } from '../shared.types';
/**
* A markdown entry for generating italic text.
*/
export interface ItalicEntry extends MarkdownEntry, RichTextEntry {
/**
* The italic text contents and identifying property for the renderer.
*/
italic: RichTextEntry;
/**
* Indicator determining what character is used to denote italics.
* Default: '*'
*/
indicator?: '*' | '_';
}
/**
* The renderer for italic entries.
*
* @param entry The italic entry.
* @param options Document-level render options.
* @returns Italic markdown content.
*/
export declare const italicRenderer: MarkdownRenderer;
export declare function italic(content: ItalicEntry['italic'], options?: Omit<ItalicEntry, 'italic'>): ItalicEntry;