markdown vs markdown-it vs remark vs showdown
Markdown Parsing Libraries
Search packages..
markdownmarkdown-itremarkshowdownSimilar Packages:

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.

Npm Package Weekly Downloads Trend

3 Years

Github Stars Ranking

Stat Detail

Package
Downloads
Stars
Size
Issues
Publish
License
markdown07,695-10513 years ago-
markdown-it021,170768 kB59a month agoMIT
remark08,78615.7 kB73 years agoMIT
showdown014,839801 kB236-MIT

Feature Comparison: markdown vs markdown-it vs remark vs showdown

Extensibility

  • markdown:

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

  • 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.

Performance

  • markdown:

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

  • 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.

Learning Curve

  • markdown:

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

  • 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.

Output Quality

  • 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.

  • 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'.

Use Cases

  • markdown:

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

  • 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.

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

  • 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.

  • 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.

Similar Npm Packages to markdown

markdown is a widely-used library for converting Markdown text into HTML. It simplifies the process of rendering Markdown content in web applications, making it easier for developers to work with text formatting. While the markdown package is effective, there are several alternatives that offer additional features and flexibility. Here are a few notable options:

  • markdown-it is a powerful Markdown parser that provides a wide range of features and plugins. It is designed for performance and extensibility, allowing developers to customize the parsing process to fit their needs. With support for CommonMark and a variety of plugins, markdown-it is an excellent choice for projects that require advanced Markdown rendering capabilities or specific formatting options. Its flexibility makes it suitable for both simple and complex applications.
  • remark is a Markdown processor powered by plugins, allowing developers to transform Markdown content in various ways. It is part of the unified ecosystem, which means it can be easily integrated with other tools for processing text. remark is particularly useful for projects that require custom transformations or linting of Markdown content. If you need to manipulate Markdown in a more sophisticated manner, remark offers a robust solution with a rich plugin ecosystem.
  • showdown is a JavaScript Markdown to HTML converter that is easy to use and lightweight. It provides a straightforward API for converting Markdown text into HTML, making it a great choice for developers looking for a simple solution without the need for extensive configuration. showdown is particularly useful for projects that require quick and easy Markdown rendering without the overhead of more complex libraries.

To explore how markdown compares with markdown-it, remark, and showdown, check out the comparison: Comparing markdown vs markdown-it vs remark vs showdown.

Similar Npm Packages to markdown-it

markdown-it is a powerful Markdown parser and compiler for JavaScript. It allows developers to convert Markdown text into HTML, making it a popular choice for applications that require rich text formatting. With its extensible architecture, markdown-it supports a variety of plugins that can enhance its functionality, such as adding support for tables, footnotes, and custom syntax. Its performance and flexibility make it suitable for both small projects and large applications that need to render Markdown content efficiently.

While markdown-it is a robust option, there are other libraries available that also provide Markdown parsing capabilities. Here are a few alternatives:

  • remark is a Markdown processor powered by plugins. It is part of the unified ecosystem, which allows for a wide range of transformations on Markdown content. remark focuses on the syntax tree, enabling developers to manipulate Markdown in a more programmatic way. This makes it an excellent choice for projects that require extensive customization and processing of Markdown content, such as static site generators or documentation tools. With its plugin architecture, remark can be tailored to fit specific needs, making it highly versatile.

  • showdown is another popular Markdown to HTML converter. It is lightweight and easy to use, making it a great choice for simple applications that need to convert Markdown to HTML without the overhead of additional features. showdown is particularly useful for projects where performance is a priority, as it has a minimal footprint and straightforward API. If you need a quick and efficient way to render Markdown in your application without the need for extensive customization, showdown is an excellent option.

To compare these packages, check out the following link: Comparing markdown-it vs remark vs showdown.

Similar Npm Packages to remark

remark is a powerful Markdown processor built on the unified ecosystem, designed to parse and transform Markdown content. It allows developers to work with Markdown in a structured way, enabling the creation of custom plugins and transformations. With its extensible architecture, remark is particularly useful for applications that require advanced Markdown processing, such as static site generators or documentation tools.

While remark offers a robust solution for handling Markdown, there are several alternatives available in the ecosystem that cater to different needs:

  • markdown-it is a fast and flexible Markdown parser that is designed to be extensible and customizable. It supports a wide range of Markdown features and syntax, making it a popular choice for projects that require a high level of compatibility with Markdown specifications. markdown-it also allows for the creation of plugins to extend its functionality, making it suitable for both simple and complex Markdown processing tasks.
  • marked is another widely used Markdown parser that emphasizes speed and simplicity. It is designed to convert Markdown into HTML quickly, making it a great choice for applications where performance is critical. marked supports a subset of the CommonMark specification and is easy to integrate into projects. If you need a straightforward solution for converting Markdown to HTML without the need for extensive customization, marked is an excellent option.
  • showdown is a JavaScript Markdown to HTML converter that is simple to use and lightweight. It provides a straightforward API for converting Markdown text into HTML, making it suitable for applications that require basic Markdown processing without additional complexity. showdown is particularly useful for projects that need a quick and easy way to render Markdown content in the browser or on the server.

To see how remark compares with markdown-it, marked, and showdown, check out the comparison: Comparing markdown-it vs marked vs remark vs showdown.

Similar Npm Packages to showdown

showdown is a popular JavaScript library that converts Markdown into HTML. It is lightweight and easy to use, making it a great choice for developers looking to integrate Markdown support into their web applications. Showdown provides a simple API for converting Markdown text to HTML, and it supports a variety of Markdown features, including tables, lists, and code blocks. Its flexibility and ease of integration make it a preferred option for many developers working with Markdown content.

However, there are several alternatives to Showdown that also provide Markdown parsing and rendering capabilities. Here are a few noteworthy options:

  • markdown-it is a powerful Markdown parser that is highly extensible and customizable. It supports a wide range of Markdown features and allows developers to create plugins to extend its functionality. Markdown-it is known for its performance and flexibility, making it suitable for applications that require advanced Markdown processing. If you need a robust solution with a rich plugin ecosystem, markdown-it is an excellent choice.

  • marked is another fast and lightweight Markdown parser that is designed for speed and efficiency. It is simple to use and provides a straightforward API for converting Markdown to HTML. Marked is particularly known for its performance, making it ideal for applications that need to render large amounts of Markdown content quickly. If you prioritize speed and simplicity, marked is a solid option.

  • remarkable is a Markdown parser that focuses on extensibility and customization. It offers a variety of features, including support for custom syntax and plugins. Remarkable is designed to be fast and efficient while providing a high level of customization for developers who need specific Markdown features. If you are looking for a parser that allows for deep customization, remarkable is worth considering.

To compare these packages and see how they stack up against each other, check out the following link: Comparing markdown-it vs marked vs remarkable vs showdown.

README for markdown

markdown-js

Yet another markdown parser, this time for JavaScript. There's a few options that precede this project but they all treat markdown to HTML conversion as a single step process. You pass markdown in and get HTML out, end of story. We had some pretty particular views on how the process should actually look, which include:

  • producing well-formed HTML. This means that em and strong nesting is important, as is the ability to output as both HTML and XHTML

  • having an intermediate representation to allow processing of parsed data (we in fact have two, both JsonML: a markdown tree and an HTML tree)

  • being easily extensible to add new dialects without having to rewrite the entire parsing mechanics

  • having a good test suite. The only test suites we could find tested massive blocks of input, and passing depended on outputting the HTML with exactly the same whitespace as the original implementation

Installation

Just the markdown library:

npm install markdown

Optionally, install md2html into your path

npm install -g markdown

Usage

### Node

The simple way to use it with node is:

var markdown = require( "markdown" ).markdown;
console.log( markdown.toHTML( "Hello *World*!" ) );

### Browser

It also works in a browser; here is a complete example:

<!DOCTYPE html>
<html>
  <body>
    <textarea id="text-input" oninput="this.editor.update()"
              rows="6" cols="60">Type **Markdown** here.</textarea>
    <div id="preview"> </div>
    <script src="lib/markdown.js"></script>
    <script>
      function Editor(input, preview) {
        this.update = function () {
          preview.innerHTML = markdown.toHTML(input.value);
        };
        input.editor = this;
        this.update();
      }
      var $ = function (id) { return document.getElementById(id); };
      new Editor($("text-input"), $("preview"));
    </script>
  </body>
</html>

Command line

Assuming you've installed the md2html script (see Installation, above), you can convert markdown to html:

# read from a file
md2html /path/to/doc.md > /path/to/doc.html

# or from stdin
echo 'Hello *World*!' | md2html

### More options

If you want more control check out the documentation in lib/markdown.js which details all the methods and parameters available (including examples!). One day we'll get the docs generated and hosted somewhere for nicer browsing.

Meanwhile, here's an example of using the multi-step processing to make wiki-style linking work by filling in missing link references:

var md = require( "markdown" ).markdown,
    text = "[Markdown] is a simple text-based [markup language]\n" +
           "created by [John Gruber]\n\n" +
           "[John Gruber]: http://daringfireball.net";

// parse the markdown into a tree and grab the link references
var tree = md.parse( text ),
    refs = tree[ 1 ].references;

// iterate through the tree finding link references
( function find_link_refs( jsonml ) {
  if ( jsonml[ 0 ] === "link_ref" ) {
    var ref = jsonml[ 1 ].ref;

    // if there's no reference, define a wiki link
    if ( !refs[ ref ] ) {
      refs[ ref ] = {
        href: "http://en.wikipedia.org/wiki/" + ref.replace(/\s+/, "_" )
      };
    }
  }
  else if ( Array.isArray( jsonml[ 1 ] ) ) {
    jsonml[ 1 ].forEach( find_link_refs );
  }
  else if ( Array.isArray( jsonml[ 2 ] ) ) {
    jsonml[ 2 ].forEach( find_link_refs );
  }
} )( tree );

// convert the tree into html
var html = md.renderJsonML( md.toHTMLTree( tree ) );
console.log( html );

Intermediate Representation

Internally the process to convert a chunk of markdown into a chunk of HTML has three steps:

  1. Parse the markdown into a JsonML tree. Any references found in the parsing are stored in the attribute hash of the root node under the key references.

  2. Convert the markdown tree into an HTML tree. Rename any nodes that need it (bulletlist to ul for example) and lookup any references used by links or images. Remove the references attribute once done.

  3. Stringify the HTML tree being careful not to wreck whitespace where whitespace is important (surrounding inline elements for example).

Each step of this process can be called individually if you need to do some processing or modification of the data at an intermediate stage. For example, you may want to grab a list of all URLs linked to in the document before rendering it to HTML which you could do by recursing through the HTML tree looking for a nodes.

Running tests

To run the tests under node you will need tap installed (it's listed as a devDependencies so npm install from the checkout should be enough), then do

$ npm test

Contributing

Do the usual github fork and pull request dance. Add yourself to the contributors section of package.json too if you want to.

## License

Released under the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm-compare.com is an independent website designed to help developers choose the most suitable npm packages. We are not affiliated with npm, Inc, the official website for the npm registry. Note that npm is a registered trademark of npm, Inc. Please share your feedback via our GitHub repository. For more details, please refer to our Terms & Privacy.