rehype-remove-meta-http-equiv
v4.0.1
Published
rehype plugin to remove `http-equiv` `meta` elements for shorter output
Downloads
82,453
Readme
rehype-remove-meta-http-equiv
rehype plugin to remove meta[http-equiv=content-language] and
meta[http-equiv=content-type].
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Example
- Syntax
- Syntax tree
- Types
- Compatibility
- Security
- Contribute
- License
What is this?
This package is a plugin that removes <meta> elements with http-equiv
attributes.
These <meta> elements can set the character encoding and natural language
of the document, but there are shorter ways to do that.
When should I use this?
You can use this plugin when you want to improve the transfer size of HTML documents.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install rehype-remove-meta-http-equivIn Deno with esm.sh:
import rehypeRemoveMetaHttpEquiv from 'https://esm.sh/rehype-remove-meta-http-equiv@4'In browsers with esm.sh:
<script type="module">
import rehypeRemoveMetaHttpEquiv from 'https://esm.sh/rehype-remove-meta-http-equiv@4?bundle'
</script>Use
On the API:
import rehypeParse from 'rehype-parse'
import rehypeRemoveMetaHttpEquiv from 'rehype-remove-meta-http-equiv'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
const file = await unified()
.use(rehypeParse)
.use(rehypeRemoveMetaHttpEquiv)
.use(rehypeStringify)
.process(await read('index.html'))
console.log(String(file))On the CLI:
rehype input.html --use rehype-remove-meta-http-equiv --output output.htmlOn the CLI in a config file (here a package.json):
…
"rehype": {
"plugins": [
…
+ "rehype-remove-meta-http-equiv",
…
]
}
…API
This package exports no identifiers.
The default export is rehypeRemoveMetaHttpEquiv.
unified().use(rehypeRemoveMetaHttpEquiv)
Remove meta[http-equiv=content-language] and
meta[http-equiv=content-type].
Returns
Transform (Transformer).
Example
In
<!doctype html>
<html lang="en-GB">
<head>
<meta charset="utf8">
<meta http-equiv="content-type" content="text/html; charset=chinese">
<meta http-equiv="content-language" content="en-US">
</head>
<body></body>
</html>Out
(with rehype-format)
<!doctype html>
<html lang="en-US">
<head>
<meta charset="chinese">
</head>
<body></body>
</html>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-remove-meta-http-equiv@^4,
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) 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.