remark-update-legacy-badge-markers

remark plugin to update legacy badge markers to the modern zone convention

Table of Contents

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

Usage

Installation

$ npm install @form8ion/remark-update-legacy-badge-markers --save-prod

Example

Import

import fs from 'node:fs';
import {remark} from 'remark';
import updateLegacyBadgeMarkers from '@form8ion/remark-update-legacy-badge-markers';

Execute

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

<!-- status badges -->

<!-- consumer badges  -->

<!-- contribution badges -->
`,
    (err, file) => {
      fs.writeFileSync(`${process.cwd()}/README.md`, `${file}`);
    }
  );

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test