Awesome
package.json
scripts
Add a table of scripts from package.json
to markdown files via markdown-magic
Install
yarn add -D markdown-magic markdown-magic-package-scripts
Adding the plugin
See example.js
for usage.
const fs = require('fs');
const path = require('path');
const markdownMagic = require('markdown-magic');
const config = {
transforms: {
SCRIPTS: require('./index.js'),
},
};
const markdownPath = path.join(__dirname, 'README.md');
markdownMagic(markdownPath, config);
<!-- AUTO-GENERATED-CONTENT:END *-->
Usage in markdown
<!-- AUTO-GENERATED-CONTENT:START (SCRIPTS) -->Script | Description |
---|---|
docs | generate docs |
empty | echo "this is just an example" |
format | format code |
prepublish | npm hook to run before publishing |