Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including @form8ion/remark-readme with all npm packages installed. Try it out:

// #### Import // remark-usage-ignore-next import stubbedFs from 'mock-fs'; import {promises as fs} from 'node:fs'; import {remark} from 'remark'; import updateReadme from './lib/index.js'; // remark-usage-ignore-next stubbedFs(); // #### Execute // remark-usage-ignore-next (async () => { 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}`); // remark-usage-ignore-next 2 stubbedFs.restore(); })();

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@form8ion/remark-readme v2.0.0

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

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free