remark-strip-badges
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatremark plugin to remove badges (such as
shields.io
shields).Contents
* [`unified().use(remarkStripBadges)`](#unifieduseremarkstripbadges)
What is this?
This package is a unified (remark) plugin to remove badges (such asshields.io
shields).When should I use this?
This package is useful when you’re taking (user generated) readmes, which in the JavaScript community often have assorted badges, but want to display them cleanly on a website or in a limited medium such as man pages.A different plugin,
remark-squeeze-paragraphs
remark-squeeze-paragraphs,
can take care of potentially empty paragraphs left behind by this plugin.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install remark-strip-badges
In Deno with
esm.sh
esmsh:import remarkStripBadges from 'https://esm.sh/remark-strip-badges@7'
In browsers with
esm.sh
esmsh:<script type="module">
import remarkStripBadges from 'https://esm.sh/remark-strip-badges@7?bundle'
</script>
Use
Say we have the following fileexample.md
:# pluto [![Build](https://github.com/solar-system/pluto/workflows/main/badge.svg)](https://github.com/solar-system/pluto/actions)
…and a module
example.js
:import {remark} from 'remark'
import remarkStripBadges from 'remark-strip-badges'
import {read} from 'to-vfile'
const file = await remark()
.use(remarkStripBadges)
.process(await read('example.md'))
console.log(String(file))
…then running
node example.js
yields:# pluto
API
This package exports no identifiers. The default export isremarkStripBadges
api-remark-strip-badges.unified().use(remarkStripBadges)
Remove badges (such as shields.io
shields).Parameters
There are no parameters.Returns
Transform (Transformer
unified-transformer).Syntax
Any image (or image references) that references a known badge (seeis-badge
is-badge) will be removed.
If it occurs in a link, that link is also removed.Types
This package is fully typed with TypeScript. It exports no additional types.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,
remark-strip-badges@^7
, compatible with Node.js 16.This plugin works with
unified
version 3+ and remark
version 4+.Security
Use ofremark-strip-badges
does not involve rehype (hast) or
user content so there are no openings for cross-site scripting (XSS)wiki-xss
attacks.Related
— remove empty paragraphs (potentially left behind by this plugin)
Contribute
Seecontributing.md
contributing in remarkjs/.github
health for ways
to get started.
See support.md
support 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.