remarkable

What is remarkable?

The 'remarkable' npm package is a powerful markdown parser that allows you to convert markdown text into HTML. It is highly configurable and supports a wide range of markdown features, making it suitable for various use cases such as rendering markdown content on websites, converting markdown files to HTML, and more.

What are remarkable's main functionalities?

Basic Markdown to HTML Conversion

This feature allows you to convert basic markdown text into HTML. The code sample demonstrates how to convert a markdown heading into HTML.

const Remarkable = require('remarkable');
const md = new Remarkable();
const html = md.render('# Hello, world!');
console.log(html);

Custom Syntax Highlighting

This feature allows you to add custom syntax highlighting to code blocks in your markdown. The code sample demonstrates how to use the 'highlight.js' library to highlight JavaScript code within a markdown code block.

const Remarkable = require('remarkable');
const hljs = require('highlight.js');
const md = new Remarkable({
  highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
      try {
        return hljs.highlight(lang, str).value;
      } catch (__) {}
    }
    return ''; // use external default escaping
  }
});
const html = md.render('```js\nconsole.log("Hello, world!");\n```');
console.log(html);

Customizing Markdown Rendering

This feature allows you to customize various aspects of markdown rendering. The code sample demonstrates how to enable HTML tags, convert newlines to <br> tags, and automatically convert URLs to links.

const Remarkable = require('remarkable');
const md = new Remarkable({
  html: true, // Enable HTML tags in source
  xhtmlOut: true, // Use '/' to close single tags (<br />)
  breaks: true, // Convert '\n' in paragraphs into <br>
  langPrefix: 'language-', // CSS language prefix for fenced blocks
  linkify: true, // Autoconvert URL-like text to links
  typographer: true // Enable smartypants and other sweet transforms
});
const html = md.render('# Hello, world!\nThis is a [link](http://example.com).');
console.log(html);

Other packages similar to remarkable

marked

The 'marked' package is another popular markdown parser that is known for its speed and flexibility. It offers similar functionality to 'remarkable' but is often preferred for its performance and ease of use.

markdown-it

The 'markdown-it' package is a highly extensible markdown parser that supports plugins and a wide range of markdown features. It is similar to 'remarkable' in terms of configurability and feature set, but it also offers additional plugins for extended functionality.

showdown

The 'showdown' package is a markdown to HTML converter that is known for its simplicity and ease of use. It provides a straightforward API for converting markdown to HTML and is often used in projects where simplicity is a priority.

README

remarkable

Markdown parser and lexer.

Install

Install with npm:

npm i remarkable --save-dev

Usage

var markdown = require('remarkable');
console.log(markdown('# Remarkable'));
//=> <h1>Remarkable</h1>

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license

---

This file was generated by verb-cli on August 29, 2014.