markdown-it - v15.0.2
    Preparing search index...

    Interface Renderer

    Generates HTML from parsed token stream. Each instance has independent copy of rules. Those can be rewritten with ease. Also, you can add new rules if you create plugin and adds new token types.

    Creates new renderer instance and fills Renderer.rules with defaults.

    interface Renderer {
        rules: Record<string, RendererRule>;
        renderAttrs(token: Pick<Token, "attrs">): string;
        renderToken(
            tokens: Token[],
            idx: number,
            options: Required<MarkdownItOptions>,
        ): string;
        renderInline(
            tokens: Token[],
            options: Required<MarkdownItOptions>,
            env: Env | undefined,
        ): string;
        renderInlineAsText(
            tokens: Token[],
            options: Required<MarkdownItOptions>,
            env: Env | undefined,
        ): string;
        render(
            tokens: Token[],
            options: Required<MarkdownItOptions>,
            env?: Env,
        ): string;
    }
    Index
    rules
    renderAttrs renderToken renderInline renderInlineAsText render
    rules: Record<string, RendererRule> = ...

    Contains render rules for tokens. Can be updated and extended.

    See source code for more details and examples.

    import MarkdownIt from 'markdown-it'
    const md = new MarkdownIt()

    md.renderer.rules.strong_open  = function () { return '<b>'; };
    md.renderer.rules.strong_close = function () { return '</b>'; };

    const result = md.renderInline(...);

    function my_token_render(tokens, idx, options, env, renderer) {
      // ...
      return renderedHTML;
    }

    • Render token attributes to string.

      Parameters

      • token: Pick<Token, "attrs">

      Returns string

    • Special kludge for image alt attributes to conform CommonMark spec. Don't try to use it! Spec requires to show alt content with stripped markup, instead of simple escaping.

      Parameters

      Returns string

    Settings
    Member Visibility

    On This Page
    Properties
    Methods