Function markdownit

  • markdownit(): markdownit

  • Main parser/renderer class.

    Usage
    // node.js, "classic" way:
    var MarkdownIt = require('markdown-it'),
        md = new MarkdownIt();
    var result = md.render('# markdown-it rulezz!');

    // node.js, the same, but with sugar:
    var md = require('markdown-it')();
    var result = md.render('# markdown-it rulezz!');

    // browser without AMD, added to "window" on script load
    // Note, there are no dash.
    var md = window.markdownit();
    var result = md.render('# markdown-it rulezz!');

    Single line rendering, without paragraph wrap:

    var md = require('markdown-it')();
    var result = md.renderInline('__markdown-it__ rulezz!');
    Example
    // commonmark mode
    var md = require('markdown-it')('commonmark');

    // default mode
    var md = require('markdown-it')();

    // enable everything
    var md = require('markdown-it')({
      html: true,
      linkify: true,
      typographer: true
    });
    Syntax highlighting
    var hljs = require('highlight.js') // https://highlightjs.org/

    var md = require('markdown-it')({
      highlight: function (str, lang) {
        if (lang && hljs.getLanguage(lang)) {
          try {
            return hljs.highlight(lang, str, true).value;
          } catch (__) {}
        }

        return ''; // use external default escaping
      }
    });

    Or with full wrapper override (if you need assign class to <pre>):

    var hljs = require('highlight.js') // https://highlightjs.org/

    // Actual default values
    var md = require('markdown-it')({
      highlight: function (str, lang) {
        if (lang && hljs.getLanguage(lang)) {
          try {
            return '<pre class="hljs"><code>' +
                   hljs.highlight(lang, str, true).value +
                   '</code></pre>';
          } catch (__) {}
        }

        return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
      }
    });

    Returns markdownit

  • markdownit(presetName, options?): markdownit

  • Main parser/renderer class.

    Usage
    // node.js, "classic" way:
    var MarkdownIt = require('markdown-it'),
        md = new MarkdownIt();
    var result = md.render('# markdown-it rulezz!');

    // node.js, the same, but with sugar:
    var md = require('markdown-it')();
    var result = md.render('# markdown-it rulezz!');

    // browser without AMD, added to "window" on script load
    // Note, there are no dash.
    var md = window.markdownit();
    var result = md.render('# markdown-it rulezz!');

    Single line rendering, without paragraph wrap:

    var md = require('markdown-it')();
    var result = md.renderInline('__markdown-it__ rulezz!');
    Example
    // commonmark mode
    var md = require('markdown-it')('commonmark');

    // default mode
    var md = require('markdown-it')();

    // enable everything
    var md = require('markdown-it')({
      html: true,
      linkify: true,
      typographer: true
    });
    Syntax highlighting
    var hljs = require('highlight.js') // https://highlightjs.org/

    var md = require('markdown-it')({
      highlight: function (str, lang) {
        if (lang && hljs.getLanguage(lang)) {
          try {
            return hljs.highlight(lang, str, true).value;
          } catch (__) {}
        }

        return ''; // use external default escaping
      }
    });

    Or with full wrapper override (if you need assign class to <pre>):

    var hljs = require('highlight.js') // https://highlightjs.org/

    // Actual default values
    var md = require('markdown-it')({
      highlight: function (str, lang) {
        if (lang && hljs.getLanguage(lang)) {
          try {
            return '<pre class="hljs"><code>' +
                   hljs.highlight(lang, str, true).value +
                   '</code></pre>';
          } catch (__) {}
        }

        return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
      }
    });

    Parameters

    Returns markdownit

  • markdownit(options): markdownit

  • Main parser/renderer class.

    Usage
    // node.js, "classic" way:
    var MarkdownIt = require('markdown-it'),
        md = new MarkdownIt();
    var result = md.render('# markdown-it rulezz!');

    // node.js, the same, but with sugar:
    var md = require('markdown-it')();
    var result = md.render('# markdown-it rulezz!');

    // browser without AMD, added to "window" on script load
    // Note, there are no dash.
    var md = window.markdownit();
    var result = md.render('# markdown-it rulezz!');

    Single line rendering, without paragraph wrap:

    var md = require('markdown-it')();
    var result = md.renderInline('__markdown-it__ rulezz!');
    Example
    // commonmark mode
    var md = require('markdown-it')('commonmark');

    // default mode
    var md = require('markdown-it')();

    // enable everything
    var md = require('markdown-it')({
      html: true,
      linkify: true,
      typographer: true
    });
    Syntax highlighting
    var hljs = require('highlight.js') // https://highlightjs.org/

    var md = require('markdown-it')({
      highlight: function (str, lang) {
        if (lang && hljs.getLanguage(lang)) {
          try {
            return hljs.highlight(lang, str, true).value;
          } catch (__) {}
        }

        return ''; // use external default escaping
      }
    });

    Or with full wrapper override (if you need assign class to <pre>):

    var hljs = require('highlight.js') // https://highlightjs.org/

    // Actual default values
    var md = require('markdown-it')({
      highlight: function (str, lang) {
        if (lang && hljs.getLanguage(lang)) {
          try {
            return '<pre class="hljs"><code>' +
                   hljs.highlight(lang, str, true).value +
                   '</code></pre>';
          } catch (__) {}
        }

        return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
      }
    });

    Parameters

    Returns markdownit

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc