Home

Awesome

markdown-magic-engines

Print engine requirements from package.json via markdown-magic

Install

yarn add -D markdown-magic markdown-magic-engines

Note: markdown-magic is a peer dependency and must be installed separately from this module

Adding the plugin

See example.js for usage.

<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./example.js) --> <!-- The below code snippet is automatically added from ./example.js --> 
const fs = require('fs');
const path = require('path');
const markdownMagic = require('markdown-magic');

const config = {
  transforms: {
    ENGINES: require('./index.js'),
  },
};

const markdownPath = path.join(__dirname, 'README.md');
markdownMagic(markdownPath, config);
<!-- AUTO-GENERATED-CONTENT:END *-->

Usage in markdown

<!-- AUTO-GENERATED-CONTENT:START (ENGINES) --> <!-- AUTO-GENERATED-CONTENT:END -->