rehype

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[unified][] processor to add support for parsing from HTML and serializing
to HTML.

Contents

* What is this?
* When should I use this?
* Install
* Use
* API
* rehype()
* Examples
* Example: passing options to rehype-parse, rehype-stringify
* Syntax
* Syntax tree
* Types
* Compatibility
* Security
* Contribute
* Sponsor
* License

What is this?

This package is a [unified][] processor with support for parsing HTML as input
and serializing HTML as output by using unified with
[rehype-parse][rehype-parse] and [rehype-stringify][rehype-stringify].

See [the monorepo readme][rehype] for info on what the rehype ecosystem is.

When should I use this?

You can use this package when you want to use unified, have HTML as input, and
want HTML as output.
This package is a shortcut for
unified().use(rehypeParse).use(rehypeStringify).
When the input isn’t HTML (meaning you don’t need rehype-parse) or the
output is not HTML (you don’t need rehype-stringify), it’s recommended to
use unified directly.

When you’re in a browser, trust your content, don’t need positional info on
nodes or formatting options, and value a smaller bundle size, you can use
[rehype-dom][rehype-dom] instead.

When you want to inspect and format HTML files in a project on the command
line, you can use [rehype-cli][rehype-cli].

Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

``sh
npm install rehype
`

In Deno with [esm.sh][esmsh]:

`js
import {rehype} from 'https://esm.sh/rehype@13'
`

In browsers with [esm.sh][esmsh]:

`html

`

Use

Say we have the following module example.js:

`js
import {rehype} from 'rehype'
import rehypeFormat from 'rehype-format'

const file = await rehype().use(rehypeFormat).process(

Hello!

)

console.error(String(file))
`

…running that with node example.js yields:

`html








Hello!




`

API

This package exports the identifier [rehype][api-rehype].
There is no default export.

$3

Create a new unified processor that already uses
[rehype-parse][rehype-parse] and [rehype-stringify][rehype-stringify].

You can add more plugins with use.
See [unified][unified] for more information.

Examples

$3

When you use rehype-parse or rehype-stringify manually you can pass options
directly to them with use.
Because both plugins are already used in rehype, that’s not possible.
To define options for them, you can instead pass options to data:

`js
import {rehype} from 'rehype'
import {reporter} from 'vfile-reporter'

const file = await rehype()
.data('settings', {
emitParseErrors: true,
fragment: true,
preferUnquoted: true
})
.process('

')

console.error(reporter(file))
console.log(String(file))
`

…yields:

`txt
1:21-1:21 warning Unexpected duplicate attribute duplicate-attribute hast-util-from-html

⚠ 1 warning
`

`html



`

Syntax

HTML is parsed and serialized according to WHATWG HTML (the living standard),
which is also followed by all browsers.

Syntax tree

The syntax tree format used in rehype is [hast][].

Types

This package is fully typed with [TypeScript][].
It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with maintained
versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, rehype@^13, compatible
with Node.js 16.

Security

As rehype works on HTML, and improper use of HTML can open you up to a
[cross-site scripting (XSS)][xss] attack, use of rehype can also be unsafe.
Use [rehype-sanitize][rehype-sanitize] to make the tree safe.

Use of rehype plugins could also open you up to other attacks.
Carefully assess each plugin and the risks involved in using them.

For info on how to submit a report, see our [security policy][security].

Contribute

See [contributing.md][contributing] in [rehypejs/.github][health] for ways
to get started.
See [support.md`][support] for ways to get help.

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

Sponsor

Support this effort and give back by sponsoring on [OpenCollective][collective]!

Vercel		Motif		HashiCorp		GitBook		Gatsby
Netlify		Coinbase	ThemeIsle	Expo	Boost Note	Markdown Space	Holloway
		You?

License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/rehypejs/rehype/workflows/main/badge.svg

[build]: https://github.com/rehypejs/rehype/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype.svg

[coverage]: https://codecov.io/github/rehypejs/rehype

[downloads-badge]: https://img.shields.io/npm/dm/rehype.svg

[downloads]: https://www.npmjs.com/package/rehype

[size-badge]: https://img.shields.io/bundlejs/size/rehype

[size]: https://bundlejs.com/?q=rehype

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/rehypejs/rehype/discussions

[health]: https://github.com/rehypejs/.github

[security]: https://github.com/rehypejs/.github/blob/main/security.md

[contributing]: https://github.com/rehypejs/.github/blob/main/contributing.md

[support]: https://github.com/rehypejs/.github/blob/main/support.md

[coc]: https://github.com/rehypejs/.github/blob/main/code-of-conduct.md

[license]: https://github.com/rehypejs/rehype/blob/main/license

[author]: https://wooorm.com

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[npm]: https://docs.npmjs.com/cli/install

[esmsh]: https://esm.sh

[unified]: https://github.com/unifiedjs/unified

[rehype]: https://github.com/rehypejs/rehype

[hast]: https://github.com/syntax-tree/hast

[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting

[typescript]: https://www.typescriptlang.org

[rehype-parse]: ../rehype-parse/

[rehype-stringify]: ../rehype-stringify/

[rehype-cli]: ../rehype-cli/

[rehype-sanitize]: https://github.com/rehypejs/rehype-sanitize

[rehype-dom]: https://github.com/rehypejs/rehype-dom/tree/main/packages/rehype-dom

[api-rehype]: #rehype-1