unified

Project: rehypejs/rehype

Package: rehype@11.0.0

  1. Dependencies: 3·Dependents: 26
  2. HTML processor powered by plugins part of the unified collective
  1. unified 146
  2. html 106
  3. rehype 71
  4. tree 40
  5. syntax 30
  6. ast 27
  7. parse 20
  8. stringify 17
  9. abstract 10
  10. serialize 8
  11. process 7

rehype

Build Coverage Downloads Size Sponsors Backers Chat

unified processor to parse and serialize HTML. Powered by plugins. Part of the unified collective.

Don’t need the parser? Or the compiler? That’s OK.

If you’re in a browser, trust the content, and value a smaller bundle size, use rehype-dom instead.

Sponsors



🥇 Vercel


🥇 Gatsby


🥇 Netlify


Holloway




You?

Read more about the unified collective on Medium »

Install

npm:

npm install rehype

Use

var rehype = require('rehype')
var report = require('vfile-reporter')

rehype().process('<title>Hi</title><h2>Hello world!', function(err, file) {
  console.log(report(err || file))
  console.log(String(file))
})

Yields:

no issues found
<html><head><title>Hi</title></head><body><h2>Hello world!</h2></body></html>

Configuration for rehype-parse and rehype-stringify can be set with .data('settings', {/*...*/}).

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.

Contribute

See contributing.md in rehypejs/.github for ways to get started. See support.md for ways to get help. Ideas for new plugins and tools can be posted in rehypejs/ideas.

A curated list of awesome rehype resources can be found in awesome rehype.

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