remark-html

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.

Install

This package is ESM only: Node 12+ is needed to use it and it must be

import

require

npm:

npm install remark-html

Use

Say we have the following file,

example.md

# Hello & World

> A block quote.

Some emphasis, importance, and code.

And our module,

example.js

import fs from 'node:fs'
import {unified} from 'unified'
import remarkParse from 'remark-parse'
import remarkHtml from 'remark-html'



const buf = fs.readFileSync('example.md')
unified()
  .use(remarkParse)
  .use(remarkHtml)
  .process(buf)
  .then((file) => {
    console.log(String(file))
  })

Now, running

node example

Hello & World

A block quote.

• Some emphasis, importance, and code.

API

This package exports no identifiers. The default export is

remarkHtml

unified().use(remarkHtml[, options])

Serialize Markdown as HTML.

options

All options except for

sanitize

handlers

hast-util-to-html

The underlying tools allow much more customisation. It is recommended to replace this project with

remark-rehype

rehype-stringify

options.handlers

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

mdast-util-to-hast

options.sanitize

How to sanitize the output (

Object

boolean

true

• false

  — HTML is not sanitized, dangerous HTML persists

• true

  — HTML is sanitized according to GitHub’s sanitation rules, dangerous HTML is dropped

• Object

  — the object is treated as a

  schema

  for how to sanitize with

  hast-util-sanitize

  , dangerous HTML is dropped

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

rehype-raw

.

For example, to add strict sanitation but allowing

className

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

var schema = merge(github, {attributes: {'*': ['className']}})
remark()
  .use(html, {sanitize: schema})
  .processSync(/* … */)

Security

Use of

remark-html

sanitize: true

sanitize

Contribute

See

contributing.md

remarkjs/.github

support.md

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer