# 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**][unified] processor to parse and serialize HTML.
Powered by [plugins][].
Part of the [unified][] [collective][].
* API by [**unified**][unified]
* Parses HTML to the tree with [`rehype-parse`][parse]
* [**hast**][hast] syntax tree
* [Plugins][] transform the tree
* Serializes the tree to HTML with [`rehype-stringify`][stringify]
Don’t need the parser?
Or the compiler?
[That’s OK][unified-use].
If you’re in a browser, trust the content, and value a smaller bundle size, use
[`rehype-dom`][rehype-dom] instead.
## Sponsors
[**Read more about the unified collective on Medium »**][announcement]
## Install
[npm][]:
```sh
npm install rehype
```
## Use
```js
var rehype = require('rehype')
var report = require('vfile-reporter')
rehype().process('HiHello world!', function(err, file) {
console.log(report(err || file))
console.log(String(file))
})
```
Yields:
```txt
no issues found
HiHello world!
```
Configuration for [`rehype-parse`][parse] and [`rehype-stringify`][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)][xss] attack, use of rehype can also be unsafe.
Use [`rehype-sanitize`][sanitize] to make the tree safe.
## Contribute
See [`contributing.md`][contributing] in [`rehypejs/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.
Ideas for new plugins and tools can be posted in [`rehypejs/ideas`][ideas].
A curated list of awesome rehype resources can be found in [**awesome
rehype**][awesome].
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://img.shields.io/travis/rehypejs/rehype.svg
[build]: https://travis-ci.org/rehypejs/rehype
[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/bundlephobia/minzip/rehype.svg
[size]: https://bundlephobia.com/result?p=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-spectrum-7b16ff.svg
[chat]: https://spectrum.chat/unified/rehype
[health]: https://github.com/rehypejs/.github
[contributing]: https://github.com/rehypejs/.github/blob/master/contributing.md
[support]: https://github.com/rehypejs/.github/blob/master/support.md
[coc]: https://github.com/rehypejs/.github/blob/master/code-of-conduct.md
[ideas]: https://github.com/rehypejs/ideas
[awesome]: https://github.com/rehypejs/awesome-rehype
[license]: https://github.com/rehypejs/rehype/blob/master/license
[author]: https://wooorm.com
[npm]: https://docs.npmjs.com/cli/install
[unified]: https://github.com/unifiedjs/unified
[hast]: https://github.com/syntax-tree/hast
[parse]: https://github.com/rehypejs/rehype/blob/master/packages/rehype-parse
[stringify]: https://github.com/rehypejs/rehype/blob/master/packages/rehype-stringify
[rehype-dom]: https://github.com/rehypejs/rehype-dom/tree/master/packages/rehype-dom
[plugins]: https://github.com/rehypejs/rehype/blob/master/doc/plugins.md
[unified-use]: https://github.com/unifiedjs/unified#use
[announcement]: https://medium.com/unifiedjs/collectively-evolving-through-crowdsourcing-22c359ea95cc
[sanitize]: https://github.com/rehypejs/rehype-sanitize
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
