markdown-magic-subpackage-list

Print a list of subpackages for markdown file

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
markdown-magic-subpackage-list
101.1.22 years ago7 years agoMinified + gzip package size for markdown-magic-subpackage-list in KB

Readme

Subpackage list plugin
Add a list of sub-packages with links via markdown-magic

Install

npm i markdown-magic markdown-magic-subpackage-list --save-dev

Adding the plugin

See example.js for usage.
const fs = require('fs');
const path = require('path');
const markdownMagic = require('markdown-magic');

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

const markdownPath = path.join(__dirname, 'README.md');
markdownMagic(markdownPath, config);

Usage in markdown

Options

  • dir - ./packages by default
  • verbose - false by default - print out description of package
  • bullet - * by default - set to 1. to create a numbered list