3.2.1 • Published 9 months ago
@form8ion/remark-inject-badges v3.2.1
remark-inject-badges
remark plugin to inject badges into form8ion conventional zones
Table of Contents
Usage
Installation
$ npm install @form8ion/remark-inject-badges --save-dev
Example
Import
import fs from 'node:fs';
import {remark} from 'remark';
import injectBadges from '@form8ion/remark-inject-badges';
Execute
remark()
.use(
injectBadges,
{
contribution: {
badgeKey: {
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}`);
}
);
Contributing
Dependencies
$ nvm install
$ npm install
Verification
$ npm test
3.2.1
9 months ago
3.2.0
10 months ago
3.1.0
10 months ago
3.0.0
10 months ago
2.0.3
2 years ago
2.0.2
2 years ago
2.0.1
2 years ago
2.0.0
2 years ago
1.0.0-alpha.6
4 years ago
1.1.0
4 years ago
1.0.1
4 years ago
1.0.0
4 years ago
1.0.0-alpha.5
4 years ago
1.0.0-alpha.4
4 years ago
1.0.0-alpha.3
4 years ago
1.0.0-alpha.2
4 years ago
1.0.0-alpha.1
4 years ago