rehype plugin to use browser APIs to stringify HTML

Downloads in past


3.0.1a year ago5 years agoMinified + gzip package size for rehype-dom-stringify in KB


!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
rehype plugin to add support for serializing HTML in browsers.


*   [`unified().use(rehypeDomStringify[, options])`](#unifieduserehypedomstringify-options)

What is this?

This is like rehype-stringify
rehype-stringify but for browsers. This plugin uses DOM APIs to do its work, which makes it smaller in browsers, at the cost of not supporting formatting options.

When should I use this?

Use this package when you want to use rehype-stringify solely in browsers. See the monorepo readmerehype-dom for info on when to use rehype-dom.
This plugin is built on hast-util-to-domhast-util-to-dom, which is a low level tool to turn hast syntax trees into DOM nodes. rehype focusses on making it easier to transform content by abstracting such internals away.


This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install rehype-dom-stringify

In Deno with Skypack:
import rehypeDomStringify from ''

In browsers with Skypack:
<script type="module">
  import rehypeDomStringify from ''


Say our page example.html looks as follows:
<!doctype html>
<script type="module">
  import {unified} from ''
  import remarkParse from ''
  import remarkRehype from ''
  import rehypeDomStringify from ''

  const file = await unified()
    .process('# Hello, world!')


Now running open example.html prints the following to the console:
<h1>Hello, world!</h1>


This package exports no identifiers. The default export is rehypeDomStringify.

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

Add support for serializing HTML.
Configuration (optional).
Specify whether to serialize a fragment (boolean, default: true), instead of a complete document. In document mode, an html element is added when needed.
👉 Note: the default of the fragment option is true in this package, which is different from the value in rehype-stringify, because it makes more sense in browsers.


This package is fully typed with TypeScript. The extra type Options is exported.


Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.


Use of rehype-dom-stringify can open you up to a cross-site scripting (XSS)xss attack if the result is used with the actual DOM. Use rehype-sanitizerehype-sanitize to solve that.


See contributing.mdcontributing in rehypejs/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organisation, or community you agree to abide by its terms.


ISClicense © Keith McKnightauthor