remark-remove-greenkeeper-badge

remark plugin for removing a greenkeeper badge

Table of Contents

• Usage
  • Installation
  • Example
  • Import
  • Execute
• Contributing
  • Dependencies
  • Verification

Usage

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

Dependencies

$ nvm install
$ npm install

Verification

$ npm test