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

2.0.0 • Public • Published

remark-update-legacy-badge-markers

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

Node CI Workflow Status

Table of Contents

Usage

MIT license npm Try on RunKit node

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 Welcome Conventional Commits Commitizen friendly semantic-release Renovate

Dependencies

$ nvm install
$ npm install

Verification

$ npm test

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

    Package Sidebar

    Install

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

    Weekly Downloads

    1,073

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    16.8 kB

    Total Files

    6

    Last publish

    Collaborators

    • travi
    • form8ion-bot