remark-strip-badges

remark plugin to remove badges (such as shields.io).

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • unified().use(remarkStripBadges)
• Syntax
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a unified (remark) plugin to remove badges (such as shields.io).

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, can take care of potentially empty paragraphs left behind by this plugin.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install remark-strip-badges

In Deno with esm.sh:

import remarkStripBadges from 'https://esm.sh/remark-strip-badges@7'

In browsers with esm.sh:

<script type="module">
  import remarkStripBadges from 'https://esm.sh/remark-strip-badges@7?bundle'
</script>

Use

Say we have the following file example.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 is remarkStripBadges.

unified().use(remarkStripBadges)

Remove badges (such as shields.io).

Parameters

There are no parameters.

Returns

Transform (Transformer).

Syntax

Any image (or image references) that references a known badge (see 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 of remark-strip-badges does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks.

Related

• remark-squeeze-paragraphs — remove empty paragraphs (potentially left behind by this plugin)

Contribute

See contributing.md in remarkjs/.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