# Subpackage list plugin

Add a list of sub-packages with links via [markdown-magic](https://github.com/DavidWells/markdown-magic)

## Install

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

## Adding the plugin

See `example.ts` for usage.

<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./example.ts) -->

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

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

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

<!-- AUTO-GENERATED-CONTENT:END *-->

## Usage in markdown

<!-- AUTO-GENERATED-CONTENT:START (SUBPACKAGELIST:verbose=true) -->

- [example-package](packages/example) - example package description for the demo

<!-- AUTO-GENERATED-CONTENT:END -->

## 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