Project: remarkjs/remark-html

Package: remark-html@13.0.1

  1. Dependents: 183
  2. remark plugin to compile Markdown to HTML
  1. remark 199
  2. unified 173
  3. markdown 137
  4. plugin 135
  5. html 112
  6. mdast 89
  7. remark-plugin 77
  8. stringify 18
  9. compile 14


Build Coverage Downloads Size Sponsors Backers Chat

remark plugin to serialize Markdown as 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.


This plugin is ready for the new parser in remark (remarkjs/remark#536). The current and previous version of the plugin works with the current and previous version of remark.



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])

Serialize Markdown as HTML.


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


Object mapping mdast nodes to functions handling them. This option is passed to mdast-util-to-hast.


How to sanitize the output (Object or boolean, default: true):

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(/* … */)


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>


Use of remark-html is unsafe by default and opens you up to a cross-site scripting (XSS) attack. Pass sanitize: true to prevent attacks. Settings sanitize to anything else may be unsafe.


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, organization, or community you agree to abide by its terms.


MIT © Titus Wormer