rehype-remove-comments

rehype plugin to remove comments (except conditional comments)

Usage no npm install needed!

<script type="module">
  import rehypeRemoveComments from 'https://cdn.skypack.dev/rehype-remove-comments';
</script>

README

rehype-remove-comments

Build Coverage Downloads Size Sponsors Backers Chat

Remove comments (except conditional comments).

When configured with force: true (default: false), conditional comments are also removed.

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-remove-comments

This package exports no identifiers. The default export is rehypeRemoveComments

Use

On the API:

 import {unified} from 'unified'
 import rehypeParse from 'rehype-parse'
+import rehypeRemoveComments from 'rehype-remove-comments'
 import rehypeStringify from 'rehype-stringify'

 unified()
   .use(rehypeParse)
+  .use(rehypeRemoveComments)
   .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 remove-comments --output output.html

Example

In
<!--Hello-->
<!--[if IE 6]>OK<![endif]-->
Out
<!--[if IE 6]>OK<![endif]-->

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