Nevertheless Published Mine

    @form8ion/remark-inject-badges

    2.0.3 • Public • Published

    remark-inject-badges

    remark plugin to inject badges into form8ion conventional zones

    Node CI Workflow Status

    Table of Contents

    Usage

    MIT license npm Try @form8ion/remark-inject-badges on RunKit node

    Installation

    $ npm install @form8ion/remark-inject-badges --save-dev

    Example

    Import

    import fs from 'fs';
    import remark from 'remark';
    import injectBadges from '@form8ion/remark-inject-badges';

    Execute

    remark()
      .use(
        injectBadges,
        {
          contribution: {
            text: 'alt-text for the badge image',
            link: 'url for badge link',
            img: 'badge image url'
          }
        }
      )
      .process(
        `# project-name
    
    <!--status-badges start -->
    <!--status-badges end -->
    
    <!--consumer-badges start -->
    <!--consumer-badges end -->
    
    <!--contribution-badges start -->
    <!--contribution-badges end -->
    `,
        (err, file) => {
          fs.writeFileSync(`${process.cwd()}/README.md`, file.contents);
        }
      );

    Contributing

    PRs Welcome Conventional Commits Commitizen friendly semantic-release Renovate

    Dependencies

    $ nvm install
    $ npm install

    Verification

    $ npm test

    Keywords

    none

    Install

    npm i @form8ion/remark-inject-badges

    DownloadsWeekly Downloads

    694

    Version

    2.0.3

    License

    MIT

    Unpacked Size

    23.9 kB

    Total Files

    8

    Last publish

    Collaborators

    • travi
    • form8ion-bot