1.0.0 • Published 3 years ago
markdown-magic-subpackage-table v1.0.0
Markdown Magic Subpackage Table
Add a table of subpackages to markdown files via markdown-magic
Install
yarn add --dev markdown-magic markdown-magic-subpackage-table
Adding the plugin
See src/example.ts
for usage, or use it in your markdown.config.js file for CLI usage.
module.exports = {
transforms: {
SUBPACKAGETABLE: require('markdown-magic-subpackage-table'),
},
}
Usage in markdown
This is generated using this plugin src/example.ts
:
Package | Description | Version | License |
---|---|---|---|
example | Example subpackage to test this package | 1.1.1 | MIT |
Options
- dir (./packages) - packages directory path
- sortKey ('name') - sort key to sort by, can be:
name
,link
,description
,version
orlicense
.
1.0.0
3 years ago