README
snippets-table
Overview
Tool to easily manage a table of snippets on a README file.
Installation
Install the package:
npm i --dev snippets-table
or yarn add -D snippets-table
Usage
Check the
example
folder.
Add the following lines to the README where the table of snippets should be created:
<!-- SNIPPETS-TABLE:START - Do not remove or modify this line -->
<!-- SNIPPETS-TABLE:END -->
Run the command:
npm run snippets-table generate
or yarn snippets-table generate
Alternatively, run it with npx
:
npx snippets-table generate
License
MIT © Arthur Denner