@form8ion/remark-readme

remark-readme

remark plugin for transforming the README for projects that follow form8ion conventions

Table of Contents

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

Usage

Installation

$ npm install @form8ion/remark-readme --save

Example

Import

import {promises as fs} from 'node:fs';
import {remark} from 'remark';
import updateReadme from '@form8ion/remark-readme';

Execute

  const file = await remark()
    .use(
      updateReadme,
      {
        usage: 'information about using the project'
      }
    )
    .process(
      `# project-name

Description of the project

<!--status-badges start -->
<!--status-badges end -->

<!--consumer-badges start -->
<!--consumer-badges end -->

<!--contribution-badges start -->
<!--contribution-badges end -->
`
    );

  await fs.writeFile(`${process.cwd()}/README.md`, `${file}`);

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test