@form8ion/remark-update-legacy-badge-markers

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

!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 on RunKitrunkit-badgerunkit-link !nodenode-badge

Installation

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

Example

Import

import fs from '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

!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