📦 This package has moved. It now lives in the markdown-magic-plugins monorepo at packages/subpackage-list. This repository is archived; issues and contributions go to the monorepo.

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.

import path from 'path';
import { markdownMagic } from 'markdown-magic';
import SUBPACKAGELIST from './index.js';

const config = {
  matchWord: 'AUTO-GENERATED-CONTENT',
  transforms: {
    SUBPACKAGELIST,
  },
};

const markdownPath = path.join(import.meta.dirname, 'README.md');
await markdownMagic(markdownPath, config);

Usage in markdown

• example-package - example package description for the demo

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