unified

Project: rehypejs/rehype-dom

Package: rehype-dom-stringify@3.0.1

  1. Dependents: 0
  2. rehype plugin to use browser APIs to stringify HTML
  1. unified 181
  2. html 124
  3. rehype 91
  4. tree 44
  5. ast 37
  6. syntax 28
  7. stringify 19
  8. compile 14
  9. abstract 10
  10. dom 9

rehype-dom-stringify

Build Coverage Downloads Size Sponsors Backers Chat

rehype plugin to add support for serializing HTML in browsers.

Contents

What is this?

This is like 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 readme for info on when to use rehype-dom.

This plugin is built on hast-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.

Install

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 esm.sh:

import rehypeDomStringify from 'https://esm.sh/rehype-dom-stringify@3'

In browsers with esm.sh:

<script type="module">
  import rehypeDomStringify from 'https://esm.sh/rehype-dom-stringify@3?bundle'
</script>

Use

Say our page example.html looks as follows:

<!doctype html>
<title>Example</title>
<body>
<script type="module">
  import {unified} from 'https://esm.sh/unified@10?bundle'
  import remarkParse from 'https://esm.sh/remark-parse@10?bundle'
  import remarkRehype from 'https://esm.sh/remark-rehype@10?bundle'
  import rehypeDomStringify from 'https://esm.sh/rehype-dom-stringify@3?bundle'

  const file = await unified()
    .use(remarkParse)
    .use(remarkRehype)
    .use(rehypeDomStringify)
    .process('# Hello, world!')

  console.log(String(file))
</script>

Now running open example.html prints the following to the console:

<h1>Hello, world!</h1>

API

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

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

Add support for serializing HTML.

options

Configuration (optional).

options.fragment

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.

Types

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

Compatibility

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.

Security

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

Contribute

See contributing.md in rehypejs/.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.

License

ISC © Keith McKnight