sgauthier
6e64e138e2
rehype-stringify
rehype plugin to serialize HTML. Compiler for unified. Stringifies hast syntax trees to HTML. Used in the rehype processor but can be used on its own as well.
If you’re in a browser, trust the content, and value a smaller bundle size, use
rehype-dom-stringify instead.
Sponsors
🥇 ZEIT |
🥇 Gatsby |
🥇 Netlify |
Holloway |
You? |
Read more about the unified collective on Medium »
Install
npm:
npm install rehype-stringify
Use
var unified = require('unified')
var createStream = require('unified-stream')
var parse = require('rehype-parse')
var stringify = require('rehype-stringify')
var processor = unified()
.use(parse)
.use(stringify, {
quoteSmart: true,
closeSelfClosing: true,
omitOptionalTags: true,
entities: {useShortestReferences: true}
})
process.stdin.pipe(createStream(processor)).pipe(process.stdout)
API
processor.use(stringify[, options])
Configure processor to serialize hast syntax trees to HTML.
options
Options can be passed when using processor.use(stringify, options) or with
processor.data('settings', options).
All settings are passed to hast-util-to-html.
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.