Interface IMarkdownParser

The interface for a Markdown parser.

interface IMarkdownParser {
    getHeadingTokens?: (source: string) => Promise<IMarkdownHeadingToken[]>;
    render(source: string): Promise<string>;
}

Hierarchy (View Summary)

Properties

getHeadingTokens?

Methods

render

Properties

OptionalgetHeadingTokens

getHeadingTokens?: (source: string) => Promise<IMarkdownHeadingToken[]>

Parse markdown and extract heading metadata.

Type declaration

Methods

render

  • render(source: string): Promise<string>

  • Render a markdown source into unsanitized HTML.

    Parameters

    • source: string

      The string to render.

    Returns Promise<string>

    • A promise of the string containing HTML which may require sanitization.

Settings

Member Visibility

On This Page

Properties
Methods