markdown-it vs remark vs showdown vs markdown
Markdown Parsing Libraries Comparison
1 Year
markdown-itremarkshowdownmarkdownSimilar Packages:
What's Markdown Parsing Libraries?

Markdown parsing libraries are tools used to convert Markdown text into HTML or other formats, enabling developers to easily render formatted text in web applications. These libraries vary in features, extensibility, and performance, catering to different needs in terms of simplicity, customization, and output quality. Choosing the right library can significantly impact the ease of integration, the flexibility of rendering options, and the overall performance of the application.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
markdown-it7,363,46319,029767 kB48a year agoMIT
remark1,985,7057,98215.7 kB0a year agoMIT
showdown729,95014,481801 kB222-MIT
markdown68,8427,701-10412 years ago-
Feature Comparison: markdown-it vs remark vs showdown vs markdown

Extensibility

  • markdown-it:

    'markdown-it' is highly extensible, allowing developers to create and integrate plugins for custom syntax and rendering options, making it ideal for complex applications.

  • remark:

    'remark' provides a robust plugin system that enables extensive transformations and custom processing of Markdown, making it the best choice for projects needing deep customization.

  • showdown:

    'showdown' offers limited extensibility through options but is primarily focused on straightforward conversion, making it less flexible than others.

  • markdown:

    The 'markdown' package is minimalistic and does not offer extensibility options, making it less suitable for projects requiring additional features or customization.

Performance

  • markdown-it:

    'markdown-it' is optimized for performance and can handle large documents efficiently, making it suitable for applications with high rendering demands.

  • remark:

    'remark' is designed for performance when processing large Markdown files, especially when using its syntax tree manipulation capabilities.

  • showdown:

    'showdown' provides decent performance for standard Markdown conversion but may not be as fast as 'markdown-it' for larger documents.

  • markdown:

    Being lightweight, 'markdown' offers fast performance for basic parsing tasks, but may struggle with larger documents or more complex features.

Learning Curve

  • markdown-it:

    'markdown-it' has a moderate learning curve, especially when utilizing its plugin system and advanced features, but is well-documented for ease of use.

  • remark:

    'remark' has a steeper learning curve due to its focus on syntax trees and transformations, which may require a deeper understanding of Markdown processing.

  • showdown:

    'showdown' is easy to learn and implement, making it a good choice for developers looking for a quick solution without complex configurations.

  • markdown:

    The 'markdown' library has a very low learning curve due to its simplicity and straightforward API, making it easy for beginners to adopt.

Output Quality

  • markdown-it:

    'markdown-it' produces high-quality HTML output with support for advanced Markdown features, making it suitable for professional applications.

  • remark:

    'remark' allows for high-quality output and offers flexibility in how the final HTML is structured, catering to specific project needs.

  • showdown:

    'showdown' generates good quality HTML output but may not handle all Markdown features as comprehensively as 'markdown-it'.

  • markdown:

    The output quality of 'markdown' is basic and may not support advanced Markdown features like tables or footnotes, limiting its use in more sophisticated applications.

Use Cases

  • markdown-it:

    Ideal for applications requiring complex Markdown processing, such as content management systems or blogs with custom syntax.

  • remark:

    Perfect for projects that need to manipulate Markdown content extensively, such as documentation generators or static site generators.

  • showdown:

    Great for quick implementations where simplicity and ease of use are prioritized, such as small web apps or personal projects.

  • markdown:

    Best suited for simple applications or static sites where basic Markdown rendering is sufficient.

How to Choose: markdown-it vs remark vs showdown vs markdown
  • markdown-it:

    Opt for 'markdown-it' if you require a highly customizable and extensible parser with support for plugins, advanced features like syntax highlighting, and a focus on performance. It's ideal for applications that need more control over the rendering process.

  • remark:

    Select 'remark' if you are looking for a powerful ecosystem for processing Markdown with a focus on syntax tree manipulation. It allows for extensive transformations and is best suited for projects that require complex processing of Markdown content.

  • showdown:

    Use 'showdown' if you need a straightforward and easy-to-use Markdown to HTML converter that works well in both browser and Node.js environments. It's particularly useful for projects that prioritize simplicity and quick setup.

  • markdown:

    Choose 'markdown' for a simple and lightweight solution if you need basic Markdown parsing without additional features or customization. It's suitable for small projects or quick implementations.

README for markdown-it

markdown-it

CI NPM version Coverage Status Gitter

Markdown parser done right. Fast and easy to extend.

Live demo

  • Follows the CommonMark spec + adds syntax extensions & sugar (URL autolinking, typographer).
  • Configurable syntax! You can add new rules and even replace existing ones.
  • High speed.
  • Safe by default.
  • Community-written plugins and other packages on npm.

Table of content

Install

node.js:

npm install markdown-it

browser (CDN):

Usage examples

See also:

Simple

// node.js
// can use `require('markdown-it')` for CJS
import markdownit from 'markdown-it'
const md = markdownit()
const result = md.render('# markdown-it rulezz!');

// browser with UMD build, added to "window" on script load
// Note, there is no dash in "markdownit".
const md = window.markdownit();
const result = md.render('# markdown-it rulezz!');

Single line rendering, without paragraph wrap:

import markdownit from 'markdown-it'
const md = markdownit()
const result = md.renderInline('__markdown-it__ rulezz!');

Init with presets and options

(*) presets define combinations of active rules and options. Can be "commonmark", "zero" or "default" (if skipped). See API docs for more details.

import markdownit from 'markdown-it'

// commonmark mode
const md = markdownit('commonmark')

// default mode
const md = markdownit()

// enable everything
const md = markdownit({
  html: true,
  linkify: true,
  typographer: true
})

// full options list (defaults)
const md = markdownit({
  // Enable HTML tags in source
  html:         false,

  // Use '/' to close single tags (<br />).
  // This is only for full CommonMark compatibility.
  xhtmlOut:     false,

  // Convert '\n' in paragraphs into <br>
  breaks:       false,

  // CSS language prefix for fenced blocks. Can be
  // useful for external highlighters.
  langPrefix:   'language-',

  // Autoconvert URL-like text to links
  linkify:      false,

  // Enable some language-neutral replacement + quotes beautification
  // For the full list of replacements, see https://github.com/markdown-it/markdown-it/blob/master/lib/rules_core/replacements.mjs
  typographer:  false,

  // Double + single quotes replacement pairs, when typographer enabled,
  // and smartquotes on. Could be either a String or an Array.
  //
  // For example, you can use '«»„“' for Russian, '„“‚‘' for German,
  // and ['«\xA0', '\xA0»', '‹\xA0', '\xA0›'] for French (including nbsp).
  quotes: '“”‘’',

  // Highlighter function. Should return escaped HTML,
  // or '' if the source string is not changed and should be escaped externally.
  // If result starts with <pre... internal wrapper is skipped.
  highlight: function (/*str, lang*/) { return ''; }
});

Plugins load

import markdownit from 'markdown-it'

const md = markdownit
  .use(plugin1)
  .use(plugin2, opts, ...)
  .use(plugin3);

Syntax highlighting

Apply syntax highlighting to fenced code blocks with the highlight option:

import markdownit from 'markdown-it'
import hljs from 'highlight.js' // https://highlightjs.org

// Actual default values
const md = markdownit({
  highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
      try {
        return hljs.highlight(str, { language: lang }).value;
      } catch (__) {}
    }

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

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

import markdownit from 'markdown-it'
import hljs from 'highlight.js' // https://highlightjs.org

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

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

Linkify

linkify: true uses linkify-it. To configure linkify-it, access the linkify instance through md.linkify:

md.linkify.set({ fuzzyEmail: false });  // disables converting email to link

API

API documentation

If you are going to write plugins, please take a look at Development info.

Syntax extensions

Embedded (enabled by default):

Via plugins:

Manage rules

By default all rules are enabled, but can be restricted by options. On plugin load all its rules are enabled automatically.

import markdownit from 'markdown-it'

// Activate/deactivate rules, with currying
const md = markdownit()
  .disable(['link', 'image'])
  .enable(['link'])
  .enable('image');

// Enable everything
const md = markdownit({
  html: true,
  linkify: true,
  typographer: true,
});

You can find all rules in sources:

Benchmark

Here is the result of readme parse at MB Pro Retina 2013 (2.4 GHz):

npm run benchmark-deps
benchmark/benchmark.mjs readme

Selected samples: (1 of 28)
 > README

Sample: README.md (7774 bytes)
 > commonmark-reference x 1,222 ops/sec ±0.96% (97 runs sampled)
 > current x 743 ops/sec ±0.84% (97 runs sampled)
 > current-commonmark x 1,568 ops/sec ±0.84% (98 runs sampled)
 > marked x 1,587 ops/sec ±4.31% (93 runs sampled)

Note. CommonMark version runs with simplified link normalizers for more "honest" compare. Difference is ≈1.5×.

As you can see, markdown-it doesn't pay with speed for its flexibility. Slowdown of "full" version caused by additional features not available in other implementations.

markdown-it for enterprise

Available as part of the Tidelift Subscription.

The maintainers of markdown-it and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.

Authors

markdown-it is the result of the decision of the authors who contributed to 99% of the Remarkable code to move to a project with the same authorship but new leadership (Vitaly and Alex). It's not a fork.

References / Thanks

Big thanks to John MacFarlane for his work on the CommonMark spec and reference implementations. His work saved us a lot of time during this project's development.

Related Links:

  • https://github.com/jgm/CommonMark - reference CommonMark implementations in C & JS, also contains latest spec & online demo.
  • http://talk.commonmark.org - CommonMark forum, good place to collaborate developers' efforts.

Ports