2.0.0 • Published 10 months ago
@form8ion/remark-readme v2.0.0
remark-readme
remark plugin for transforming the README for projects that follow form8ion conventions
Table of Contents
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
2.0.0-beta.2
10 months ago
2.0.0-beta.1
10 months ago
2.0.0
10 months ago
2.0.0-beta.3
10 months ago
1.0.0
3 years ago
1.0.0-alpha.6
3 years ago
1.0.0-alpha.5
3 years ago
1.0.0-alpha.4
3 years ago
1.0.0-alpha.3
3 years ago
1.0.0-alpha.2
3 years ago
1.0.0-alpha.1
3 years ago