1. Dependencies:4·Dependents:122
  2. remark plugin to compile Markdown to HTML
  1. remark 170
  2. unified 132
  3. plugin 88
  4. markdown 80
  5. mdast 68
  6. html 55
  7. stringify 14
  8. compile 6


Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to compile Markdown to HTML.

⚠️ This package essentially packs remark-rehype and rehype-stringify, and although it does support some customisation, it isn’t very pluggable. It’s probably smarter to use remark-rehype directly and benefit from the rehype ecosystem.



npm install remark-html


Say we have the following file, example.md:

# Hello & World

> A block quote.

* Some _emphasis_, **importance**, and `code`.

And our script, example.js, looks as follows:

var fs = require('fs')
var unified = require('unified')
var markdown = require('remark-parse')
var html = require('remark-html')

  .process(fs.readFileSync('example.md'), function(err, file) {
    if (err) throw err

Now, running node example yields:

<h1>Hello &#x26; World</h1>
<p>A block quote.</p>
<li>Some <em>emphasis</em>, <strong>importance</strong>, and <code>code</code>.</li>


remark().use(html[, options])

Compile Markdown to HTML.


All options except for sanitize are passed to hast-util-to-html.


How to sanitise the output (Object or boolean, default: false).

If false, no HTML is sanitized, and dangerous HTML is left unescaped.

If true or an object, sanitation is done by hast-util-sanitize If an object is passed in, it’s given as a schema to hast-util-sanitize. If true, input is sanitised according to GitHub’s sanitation rules.

Note that raw HTML in Markdown cannot be sanitized, so it’s removed. A schema can still be used to allow certain values from integrations though. To support HTML in Markdown, use rehype-raw.

For example, to add strict sanitation but allowing classNames, use something like:

// ...
var merge = require('deepmerge')
var github = require('hast-util-sanitize/lib/github')

var schema = merge(github, {attributes: {'*': ['className']}})

  .use(html, {sanitize: schema})
  .processSync(/* ... */)


You still need to set commonmark: true in remark-parses options.

CommonMark support is a goal but not (yet) a necessity. There are some (roughly 115 of 550, relating to inline precedence, lists, emphasis and importance) issues which I’d like to cover in the future. Note that this sounds like a lot, but they have to do with obscure differences which do not often occur in the real world.


remark-html works great with:

All mdast nodes can be compiled to HTML. Unknown mdast nodes are compiled to div nodes if they have children or text nodes if they have value.

In addition, remark-html can be told how to compile nodes through three data properties (more information):

For example, the following node:

  type: 'emphasis',
  data: {
    hName: 'i',
    hProperties: {className: 'foo'},
    hChildren: [{type: 'text', value: 'bar'}]
  children: [{type: 'text', value: 'baz'}]

…would yield:

<i class="foo">bar</i>


See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.


MIT © Titus Wormer