interface markdownit {
    block: ParserBlock;
    core: Core;
    helpers: Helpers;
    inline: ParserInline;
    linkify: LinkifyIt;
    options: markdownit.Options;
    renderer: Renderer;
    utils: Utils;
    configure(presets: PresetName): this;
    disable(list: string | string[], ignoreInvalid?: boolean): this;
    enable(list: string | string[], ignoreInvalid?: boolean): this;
    normalizeLink(url: string): string;
    normalizeLinkText(url: string): string;
    parse(src: string, env: any): Token[];
    parseInline(src: string, env: any): Token[];
    render(src: string, env?: any): string;
    renderInline(src: string, env?: any): string;
    set(options: markdownit.Options): this;
    use(plugin: PluginSimple): this;
    use<T>(plugin: PluginWithOptions<T>, options?: T): this;
    use(plugin: PluginWithParams, ...params: any[]): this;
    validateLink(url: string): boolean;
}

Properties

block: ParserBlock

Instance of [[ParserBlock]]. You may need it to add new rules when writing plugins. For simple rules control use [[MarkdownIt.disable]] and [[MarkdownIt.enable]].

core: Core

Instance of [[Core]] chain executor. You may need it to add new rules when writing plugins. For simple rules control use [[MarkdownIt.disable]] and [[MarkdownIt.enable]].

helpers: Helpers
inline: ParserInline

Instance of [[ParserInline]]. You may need it to add new rules when writing plugins. For simple rules control use [[MarkdownIt.disable]] and [[MarkdownIt.enable]].

linkify: LinkifyIt

linkify-it instance. Used by linkify rule.

renderer: Renderer

Instance of [[Renderer]]. Use it to modify output look. Or to add rendering rules for new token types, generated by plugins.

var md = require('markdown-it')();

function myToken(tokens, idx, options, env, self) {
//...
return result;
};

md.renderer.rules['my_token'] = myToken

See [[Renderer]] docs and source code.

utils: Utils

Methods

  • chainable, internal

    Batch load of all options and compenent settings. This is internal method, and you probably will not need it. But if you with - see available presets and data structure here

    We strongly recommend to use presets instead of direct config loads. That will give better compatibility with next versions.

    Parameters

    Returns this

  • chainable

    The same as [[MarkdownIt.enable]], but turn specified rules off.

    Parameters

    • list: string | string[]

      rule name or list of rule names to disable.

    • OptionalignoreInvalid: boolean

      set true to ignore errors when rule not found.

    Returns this

  • chainable

    Enable list or rules. It will automatically find appropriate components, containing rules with given names. If rule not found, and ignoreInvalid not set - throws exception.

    var md = require('markdown-it')()
    .enable(['sub', 'sup'])
    .disable('smartquotes');

    Parameters

    • list: string | string[]

      rule name or list of rule names to enable

    • OptionalignoreInvalid: boolean

      set true to ignore errors when rule not found.

    Returns this

  • Function used to encode link url to a machine-readable format, which includes url-encoding, punycode, etc.

    Parameters

    • url: string

    Returns string

  • Function used to decode link url to a human-readable format`

    Parameters

    • url: string

    Returns string

  • internal

    Parse input string and returns list of block tokens (special token type "inline" will contain list of inline tokens). You should not call this method directly, until you write custom renderer (for example, to produce AST).

    env is used to pass data between "distributed" rules and return additional metadata like reference info, needed for the renderer. It also can be used to inject data in specific cases. Usually, you will be ok to pass {}, and then pass updated object to renderer.

    Parameters

    • src: string

      source string

    • env: any

      environment sandbox

    Returns Token[]

  • internal

    The same as [[MarkdownIt.parse]] but skip all block rules. It returns the block tokens list with the single inline element, containing parsed inline tokens in children property. Also updates env object.

    Parameters

    • src: string

      source string

    • env: any

      environment sandbox

    Returns Token[]

  • Render markdown string into html. It does all magic for you :).

    env can be used to inject additional metadata ({} by default). But you will not need it with high probability. See also comment in [[MarkdownIt.parse]].

    Parameters

    • src: string

      source string

    • Optionalenv: any

      environment sandbox

    Returns string

  • Similar to [[MarkdownIt.render]] but for single paragraph content. Result will NOT be wrapped into <p> tags.

    Parameters

    • src: string

      source string

    • Optionalenv: any

      environment sandbox

    Returns string

  • chainable

    Set parser options (in the same format as in constructor). Probably, you will never need it, but you can change options after constructor call.

    var md = require('markdown-it')()
    .set({ html: true, breaks: true })
    .set({ typographer: true });

    Note: To achieve the best possible performance, don't modify a markdown-it instance options on the fly. If you need multiple configurations it's best to create multiple instances and initialize each with separate config.

    Parameters

    Returns this

  • chainable

    Load specified plugin with given params into current parser instance. It's just a sugar to call plugin(md, params) with curring.

    var iterator = require('markdown-it-for-inline');
    var md = require('markdown-it')()
    .use(iterator, 'foo_replace', 'text', function (tokens, idx) {
    tokens[idx].content = tokens[idx].content.replace(/foo/g, 'bar');
    });

    Parameters

    Returns this

  • Type Parameters

    • T = any

    Parameters

    Returns this

  • Parameters

    Returns this

  • Link validation function. CommonMark allows too much in links. By default we disable javascript:, vbscript:, file: schemas, and almost all data:... schemas except some embedded image types.

    You can change this behaviour:

    var md = require('markdown-it')();
    // enable everything
    md.validateLink = function () { return true; }

    Parameters

    • url: string

    Returns boolean