rehype-remove-comments
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorsfunding-sponsors-badgefunding
!Backersfunding-backers-badgefunding
!Chatchat-badgechatrehype plugin to remove comments.
Contents
* [`unified().use(rehypeRemoveComments[, options])`](#unifieduserehyperemovecomments-options)
* [`Options`](#options)What is this?
This package is a plugin that removes comments. By default it keeps conditional comments, optionally it removes them too.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 onlyesm. In Node.js (version 16+), install with npm:npm install rehype-remove-commentsIn Deno with
esm.shesm-sh:import rehypeRemoveComments from 'https://esm.sh/rehype-remove-comments@6'In browsers with
esm.shesm-sh:<script type="module">
import rehypeRemoveComments from 'https://esm.sh/rehype-remove-comments@6?bundle'
</script>Use
On the API:import rehypeParse from 'rehype-parse'
import rehypeRemoveComments from 'rehype-remove-comments'
import rehypeStringify from 'rehype-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
const file = await unified()
.use(rehypeParse)
.use(rehypeRemoveComments)
.use(rehypeStringify)
.process(await read('index.html'))
console.log(String(file))On the CLI:
rehype input.html --use rehype-remove-comments --output output.htmlOn the CLI in a config file (here a
package.json):…
"rehype": {
"plugins": [
…
+ "rehype-remove-comments",
…
]
}
…API
This package exports no identifiers. The default export isrehypeRemoveComments.unified().use(rehypeRemoveComments[, options])
Remove comments.Parameters
options(Options, optional)
— configurationReturns
Transform (Transformer).Options
Configuration (TypeScript type).Fields
removeConditional(boolean, default:false)
— remove conditional comments (default: `false`); the default is to
leave themExample
In
<!--Hello-->
<!--[if IE 6]>OK<![endif]-->Out
<!--[if IE 6]>OK<![endif]-->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-comments@^6,
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. Userehype-sanitizerehype-sanitize to make the tree safe.Contribute
Seecontributing.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.
