UNPKG

1.47 kBTypeScriptView Raw
1import { type DocNode, type StringBuilder, type DocLinkTag } from '@microsoft/tsdoc';
2import { IndentedWriter } from '../utils/IndentedWriter';
3export interface IMarkdownEmitterOptions {
4}
5export interface IMarkdownEmitterContext<TOptions = IMarkdownEmitterOptions> {
6 writer: IndentedWriter;
7 insideTable: boolean;
8 boldRequested: boolean;
9 italicRequested: boolean;
10 writingBold: boolean;
11 writingItalic: boolean;
12 options: TOptions;
13}
14/**
15 * Renders MarkupElement content in the Markdown file format.
16 * For more info: https://en.wikipedia.org/wiki/Markdown
17 */
18export declare class MarkdownEmitter {
19 emit(stringBuilder: StringBuilder, docNode: DocNode, options: IMarkdownEmitterOptions): string;
20 protected getEscapedText(text: string): string;
21 protected getTableEscapedText(text: string): string;
22 /**
23 * @virtual
24 */
25 protected writeNode(docNode: DocNode, context: IMarkdownEmitterContext, docNodeSiblings: boolean): void;
26 /** @virtual */
27 protected writeLinkTagWithCodeDestination(docLinkTag: DocLinkTag, context: IMarkdownEmitterContext): void;
28 /** @virtual */
29 protected writeLinkTagWithUrlDestination(docLinkTag: DocLinkTag, context: IMarkdownEmitterContext): void;
30 protected writePlainText(text: string, context: IMarkdownEmitterContext): void;
31 protected writeNodes(docNodes: ReadonlyArray<DocNode>, context: IMarkdownEmitterContext): void;
32}
33//# sourceMappingURL=MarkdownEmitter.d.ts.map
\No newline at end of file