rehype-minify-url

rehype plugin to minify URLs

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
rehype-minify-url
5.0.08 months ago8 years agoMinified + gzip package size for rehype-minify-url in KB

Popular Searches

Readme

rehype-minify-url
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorsfunding-sponsors-badgefunding !Backersfunding-backers-badgefunding !Chatchat-badgechat
rehype plugin to minify URLs.

Contents

*   [`unified().use(rehypeMinifyUrl[, options])`](#unifieduserehypeminifyurl-options)
*   [`Options`](#options)

What is this?

This package is a plugin that can minify URL values of certain attributes using relateurl.

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 onlyesm. In Node.js (version 16+), install with npm:
npm install rehype-minify-url

In Deno with esm.shesm-sh:
import rehypeMinifyUrl from 'https://esm.sh/rehype-minify-url@5'

In browsers with esm.shesm-sh:
<script type="module">
  import rehypeMinifyUrl from 'https://esm.sh/rehype-minify-url@5?bundle'
</script>

Use

On the API:
import rehypeMinifyUrl from 'rehype-minify-url'
import rehypeParse from 'rehype-parse'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'

const file = await unified()
  .use(rehypeParse)
  .use(rehypeMinifyUrl)
  .use(rehypeStringify)
  .process(await read('index.html'))

console.log(String(file))

On the CLI:
rehype input.html --use rehype-minify-url --output output.html

On the CLI in a config file (here a package.json):
…
"rehype": {
  "plugins": [
    …
+    "rehype-minify-url",
    …
  ]
}
…

API

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

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

Minify URLs.
Parameters
  • options (Options, optional)
— configuration
Returns
Transform (Transformer).

Options

Configuration (TypeScript type).
All options except for from are passed through to relateurl.
Fields
  • from (string, optional)
— absolute URL to where the document will be hosted; can also be set
with an `origin` and `pathname` in `file.data.meta` (as supported by
[`rehype-meta`](https://github.com/rehypejs/rehype-meta)).

Example

In
<a href="/foo/../bar.html"></a>
Out
(with { from: 'https://example.com' } as options)
<a href="bar.html"></a>

Syntax

HTML is parsed according to WHATWG HTML (the living standard), which is also followed by all browsers.

Syntax tree

The syntax tree used is hast.

Types

This package is fully typed with TypeScript.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, rehype-minify-url@^5, compatible with Node.js 16.

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-sanitizerehype-sanitize to make the tree safe.

Contribute

See contributing.mdcontributing in rehypejs/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor