Gathering detailed insights and metrics for rehype
Gathering detailed insights and metrics for rehype
HTML processor powered by plugins part of the @unifiedjs collective
Installations
npm install rehypeDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Node Version
22.7.0
NPM Version
10.8.3
Score
97.4
Supply Chain
97
Quality
80.4
Maintenance
100
Vulnerability
100
License
Releases
53
Languages
1
JavaScript
JavaScript (100%)
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
2,036 Stars
350 Commits
93 Forks
11 Watchers
1 Branches
49 Contributors
Updated on Jul 10, 2025
Sponsor this package
Maintainers
3
Package Meta Information
Latest Version
13.0.2
Package Id
rehype@13.0.2
Unpacked Size
12.97 kB
Size
4.69 kB
File Count
5
NPM Version
10.8.3
Node Version
22.7.0
Published on
Sep 27, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
4
rehype
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
- Examples
- 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 and rehype-stringify.
See the monorepo readme 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 instead.
When you want to inspect and format HTML files in a project on the command
line, you can use rehype-cli.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install rehype
In Deno with esm.sh:
1import {rehype} from 'https://esm.sh/rehype@13'
In browsers with esm.sh:
1<script type="module"> 2 import {rehype} from 'https://esm.sh/rehype@13?bundle' 3</script>
Use
Say we have the following module example.js:
1import {rehype} from 'rehype' 2import rehypeFormat from 'rehype-format' 3 4const file = await rehype().use(rehypeFormat).process(`<!doctype html> 5 <html lang=en> 6<head> 7 <title>Hi!</title> 8 </head> 9 <body> 10 <h1>Hello!</h1> 11 12</body></html>`) 13 14console.error(String(file))
…running that with node example.js yields:
1<!doctype html> 2<html lang="en"> 3 <head> 4 <title>Hi!</title> 5 </head> 6 <body> 7 <h1>Hello!</h1> 8 </body> 9</html>
API
This package exports the identifier rehype.
There is no default export.
rehype()
Create a new unified processor that already uses
rehype-parse and rehype-stringify.
You can add more plugins with use.
See unified for more information.
Examples
Example: passing options to rehype-parse, rehype-stringify
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:
1import {rehype} from 'rehype' 2import {reporter} from 'vfile-reporter' 3 4const file = await rehype() 5 .data('settings', { 6 emitParseErrors: true, 7 fragment: true, 8 preferUnquoted: true 9 }) 10 .process('<div title="a" title="b"></div>') 11 12console.error(reporter(file)) 13console.log(String(file))
…yields:
11:21-1:21 warning Unexpected duplicate attribute duplicate-attribute hast-util-from-html 2 3⚠ 1 warning
1<div title=a></div>
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) attack, use of rehype can also be unsafe.
Use 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.
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, organization, or community you agree to abide by its terms.
Sponsor
Support this effort and give back by sponsoring on OpenCollective!
Vercel
|
Motif
|
HashiCorp
|
GitBook
|
Gatsby
| |||||
Netlify
|
Coinbase
|
ThemeIsle
|
Expo
|
Boost Note
|
Markdown Space
|
Holloway
| |||
|
You? | |||||||||
License
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
0 existing vulnerabilities detected
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/rehypejs/.github/security.md:1
- Info: Found linked content: github.com/rehypejs/.github/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/rehypejs/.github/security.md:1
- Info: Found text in security policy: github.com/rehypejs/.github/security.md:1
Reason
Found 13/30 approved changesets -- score normalized to 4
Reason
0 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/bb.yml:1
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/bb.yml:5: update your workflow using https://app.stepsecurity.io/secureworkflow/rehypejs/rehype/bb.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:6: update your workflow using https://app.stepsecurity.io/secureworkflow/rehypejs/rehype/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:7: update your workflow using https://app.stepsecurity.io/secureworkflow/rehypejs/rehype/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/rehypejs/rehype/main.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:11
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 13 are checked with a SAST tool
Score
4.5
/10
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More