rehype-raw
    TypeScript icon, indicating that this package has built-in type declarations

    6.1.1 • Public • Published

    rehype-raw

    Build Coverage Downloads Size Sponsors Backers Chat

    rehype plugin to parse the tree (and raw nodes) again, keeping positional info okay.

    Contents

    What is this?

    This package is a unified (rehype) plugin to parse a document again. To understand how it works, requires knowledge of ASTs (specifically, hast). This plugin passes each node and embedded raw HTML through an HTML parser (parse5), to recreate a tree exactly as how a browser would parse it, while keeping the original data and positional info intact.

    unified is a project that transforms content with abstract syntax trees (ASTs). rehype adds support for HTML to unified. hast is the HTML AST that rehype uses. This is a rehype plugin that parses the tree again.

    When should I use this?

    This plugin is particularly useful when coming from markdown and wanting to support HTML embedded inside that markdown (which requires passing allowDangerousHtml: true to remark-rehype). Markdown dictates how, say, a list item or emphasis can be parsed. We can use that to turn the markdown syntax tree into an HTML syntax tree. But markdown also dictates that things that look like HTML, are passed through untouched, even when it just looks like XML but doesn’t really make sense, so we can’t normally use these strings of “HTML” to create an HTML syntax tree. This plugin can. It can be used to take those strings of HTML and include them into the syntax tree as actual nodes.

    If your final result is HTML and you trust content, then “strings” are fine (you can pass allowDangerousHtml: true to rehype-stringify, which passes HTML through untouched). But there are two main cases where a proper syntax tree is preferred:

    • rehype plugins need a proper syntax tree as they operate on actual nodes to inspect or transform things, they can’t operate on strings of HTML
    • other output formats (React, MDX, etc) need actual nodes and can’t handle strings of HTML

    This plugin is built on hast-util-raw, which does the work on syntax trees. rehype focusses on making it easier to transform content by abstracting such internals away.

    Install

    This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

    npm install rehype-raw

    In Deno with Skypack:

    import rehypeRaw from 'https://cdn.skypack.dev/rehype-raw@6?dts'

    In browsers with Skypack:

    <script type="module">
      import rehypeRaw from 'https://cdn.skypack.dev/rehype-raw@6?min'
    </script>

    Use

    Say we have the following markdown file example.md:

    <div class="note">
    
    A mix of *markdown* and <em>HTML</em>.
    
    </div>

    And our module example.js looks as follows:

    import {read} from 'to-vfile'
    import {unified} from 'unified'
    import remarkParse from 'remark-parse'
    import remarkRehype from 'remark-rehype'
    import rehypeRaw from 'rehype-raw'
    import rehypeDocument from 'rehype-document'
    import rehypeFormat from 'rehype-format'
    import rehypeStringify from 'rehype-stringify'
    
    main()
    
    async function main() {
      const file = await unified()
        .use(remarkParse)
        .use(remarkRehype, {allowDangerousHtml: true})
        .use(rehypeRaw)
        .use(rehypeDocument, {title: '🙌'})
        .use(rehypeFormat)
        .use(rehypeStringify)
        .process(await read('example.md'))
    
      console.log(String(file))
    }

    Now running node example.js yields:

    <!doctype html>
    <html lang="en">
      <head>
        <meta charset="utf-8">
        <title>🙌</title>
        <meta name="viewport" content="width=device-width, initial-scale=1">
      </head>
      <body>
        <div class="note">
          <p>A mix of <em>markdown</em> and <em>HTML</em>.</p>
        </div>
      </body>
    </html>

    API

    This package exports no identifiers. The default export is rehypeRaw.

    unified().use(rehypeRaw[, options])

    Parse the tree (and raw nodes) again, keeping positional info okay.

    options

    Configuration (optional).

    options.passThrough

    This option is a bit advanced as it requires knowledge of ASTs, so we defer to the documentation available in hast-util-raw.

    Types

    This package is fully typed with TypeScript. It exports an Options type, which specifies the interface of the accepted options.

    Compatibility

    Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    This plugin works with rehype-parse version 1+, rehype-stringify version 1+, rehype version 1+, and unified version 4+.

    Security

    The allowDangerousHtml option in remark-rehype is dangerous, so defer to that plugin on how to make it safe. Otherwise, this plugin is safe.

    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.

    License

    MIT © Titus Wormer

    Install

    npm i rehype-raw

    DownloadsWeekly Downloads

    216,297

    Version

    6.1.1

    License

    MIT

    Unpacked Size

    11.8 kB

    Total Files

    5

    Last publish

    Collaborators

    • wooorm
    • kmck