rehype plugin to prevent a network request to the favicon when there is none.
- What is this?
- When should I use this?
- Install
- Use
- API
- Example
- Syntax
- Syntax tree
- Types
- Compatibility
- Security
- Contribute
- License
This package is a plugin that inserts an empty favicon image, when there is none referenced, to prevent a network request.
You can use this plugin when you don’t have a favicon.ico at the root of
your server, and want to prevent browsers sending out a network request to
find it.
This plugin increases the size of the HTML, but prevents a round trip to the server by inserting an empty favicon.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install rehype-prevent-favicon-requestIn Deno with esm.sh:
import rehypePreventFaviconRequest from 'https://esm.sh/rehype-prevent-favicon-request@4'In browsers with esm.sh:
<script type="module">
import rehypePreventFaviconRequest from 'https://esm.sh/rehype-prevent-favicon-request@4?bundle'
</script>On the API:
import rehypeParse from 'rehype-parse'
import rehypePreventFaviconRequest from 'rehype-prevent-favicon-request'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
const file = await unified()
.use(rehypeParse)
.use(rehypePreventFaviconRequest)
.use(rehypeStringify)
.process(await read('index.html'))
console.log(String(file))On the CLI:
rehype input.html --use rehype-prevent-favicon-request --output output.htmlOn the CLI in a config file (here a package.json):
…
"rehype": {
"plugins": [
…
+ "rehype-prevent-favicon-request",
…
]
}
…This package exports no identifiers.
The default export is rehypePreventFaviconRequest.
Prevent a network request to the favicon when there is none.
Transform (Transformer).
<!doctype html><html><head></head><body></body></html><!doctype html><html><head><link href="data:image/x-icon;," rel="shortcut icon" type="image/x-icon"></head><body></body></html>HTML is parsed according to WHATWG HTML (the living standard), which is also followed by all browsers.
The syntax tree used is hast.
This package is fully typed with TypeScript.
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-prevent-favicon-request@^4,
compatible with Node.js 16.
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.
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.