rehype-prevent-favicon-request

rehype plugin to prevent a `favicon.ico` requests

Usage no npm install needed!

<script type="module">
  import rehypePreventFaviconRequest from 'https://cdn.skypack.dev/rehype-prevent-favicon-request';
</script>

README

rehype-prevent-favicon-request

Build Coverage Downloads Size Sponsors Backers Chat

Prevent a favicon.ico request.

Use this plugin if there’s no favicon.ico at the root of your server, and there may or may not be a shortcut icon referenced in your HTML.

This plugin increases the size of the HTML, but prevents a round trip to the server by inserting an empty favicon.

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install rehype-prevent-favicon-request

This package exports no identifiers. The default export is rehypePreventFaviconRequest

Use

On the API:

 import {unified} from 'unified'
 import rehypeParse from 'rehype-parse'
+import rehypePreventFaviconRequest from 'rehype-prevent-favicon-request'
 import rehypeStringify from 'rehype-stringify'

 unified()
   .use(rehypeParse)
+  .use(rehypePreventFaviconRequest)
   .use(rehypeStringify)
   .process('<span>some html</span>', function (err, file) {
     console.error(report(err || file))
     console.log(String(file))
   })

On the CLI:

rehype input.html --use prevent-favicon-request --output output.html

Example

In
<!doctype html><html><head></head><body></body></html>
Out
<!doctype html><html><head><link rel="shortcut icon" type="image/x-icon" href="data:image/x-icon;,"></head><body></body></html>

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