remark-remove-greenkeeper-badge

remark plugin for removing a greenkeeper badge

!Node CI Workflow Statusgithub-actions-ci-badgegithub-actions-ci-link

Table of Contents

• Usage

Installation Example

* [Import](#import)
* [Execute](#execute)

• Contributing

Dependencies Verification

Usage

!MIT licenselicense-badgelicense-link !npmnpm-badgenpm-link !Try remark-remove-greenkeeper-badge on RunKitrunkit-badgerunkit-link

Installation

$ npm install remark-remove-greenkeeper-badge --save-prod

Example

Import

import fs from 'node:fs';
import {remark} from 'remark';
import remarkRemoveGreenkeeperBadge from 'remark-remove-greenkeeper-badge';

Execute

remark()
  .use(remarkRemoveGreenkeeperBadge)
  .process(
    `# project-name

[![Greenkeeper badge](https://badges.greenkeeper.io/your-account/project-name.svg)](https://greenkeeper.io/)
`,
    (err, file) => {
      fs.writeFileSync(`${process.cwd()}/README.md`, `${file}`);
    }
  );

Contributing

!PRs WelcomePRs-badgePRs-link !Conventional Commitscommit-convention-badgecommit-convention-link !Commitizen friendlycommitizen-badgecommitizen-link !semantic-releasesemantic-release-badgesemantic-release-link !Renovaterenovate-badgerenovate-link

Dependencies

$ nvm install
$ npm install

Verification

$ npm test