Nightmare Prom Memories

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

    5.0.1 • Public • Published

    rehype-minify-whitespace

    Build Coverage Downloads Size Sponsors Backers Chat

    rehype plugin to minify whitespace between elements.

    Contents

    What is this?

    This package is a plugin that can minify the whitespace between elements.

    When should I use this?

    You can use this plugin when you want to improve the size of HTML documents.

    Install

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

    npm install rehype-minify-whitespace

    In Deno with Skypack:

    import rehypeMinifyWhitespace from 'https://cdn.skypack.dev/rehype-minify-whitespace@5?dts'

    In browsers with Skypack:

    <script type="module">
      import rehypeMinifyWhitespace from 'https://cdn.skypack.dev/rehype-minify-whitespace@5?min'
    </script>

    Use

    On the API:

    import {read} from 'to-vfile'
    import {unified} from 'unified'
    import rehypeParse from 'rehype-parse'
    import rehypeStringify from 'rehype-stringify'
    import rehypeMinifyWhitespace from 'rehype-minify-whitespace'
    
    main()
    
    async function main() {
      const file = await unified()
        .use(rehypeParse)
        .use(rehypeMinifyWhitespace)
        .use(rehypeStringify)
        .process(await read('index.html'))
    
      console.log(String(file))
    }

    On the CLI:

    rehype input.html --use rehype-minify-whitespace --output output.html

    On the CLI in a config file (here a package.json):

     …
     "rehype": {
       "plugins": [
         …
    +    "rehype-minify-whitespace",
         …
       ]
     }
     …

    API

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

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

    Minify whitespace.

    options

    Configuration (optional).

    options.newlines

    Whether to collapse runs of whitespace that include line endings to one line ending (boolean, default: false). The default is to collapse everything to one space.

    Example

    In
    <h1>Heading</h1>
    <p><strong>This</strong> and <em>that</em></p>
    Out
    <h1>Heading</h1><p><strong>This</strong> and <em>that</em></p>

    Syntax

    HTML is handled according to WHATWG HTML (the living standard), which is also followed by browsers such as Chrome and Firefox.

    Syntax tree

    The syntax tree format used is hast.

    Types

    This package is fully typed with TypeScript.

    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.

    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.

    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-minify-whitespace

    DownloadsWeekly Downloads

    65,434

    Version

    5.0.1

    License

    MIT

    Unpacked Size

    18.5 kB

    Total Files

    10

    Last publish

    Collaborators

    • wooorm
    • kmck