markdown-magic-dependency-table
v3.1.0
Published
Generate table of information about dependencies automatically in markdown
Maintainers
Readme
Dependency table
Add a table of dependencies to markdown files via markdown-magic
Install
npm i markdown-magic markdown-magic-dependency-table --save-devAdding the plugin
See example.ts for usage.
import path from 'path';
import { markdownMagic } from 'markdown-magic';
import DEPENDENCYTABLE from './index.ts';
const config = {
matchWord: 'AUTO-GENERATED-CONTENT',
transforms: {
DEPENDENCYTABLE,
},
};
const markdownPath = path.join(import.meta.dirname, 'README.md');
await markdownMagic(markdownPath, config);Usage in markdown
| Dependency | Description | Version | License | Type | | --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------- | ----------- | ---------- | | find-up@^8.0.0 | Find a file or directory by walking up parent directories | 8.0.0 | MIT | production | | semver@^7.0.0 | The semantic version parser used by npm. | 7.8.5 | ISC | production | | markdown-magic@^4 | Automatically update markdown files with content from external sources | 4.10.5 | MIT | peer | | @types/node@^24.13.... | TypeScript definitions for node | 24.13.2 | MIT | dev | | @types/semver@^7.7.1 | TypeScript definitions for semver | 7.7.1 | MIT | dev | | markdown-magic@^4.0.0 | Automatically update markdown files with content from external sources | 4.10.5 | MIT | dev | | prettier@^3.0.0 | Prettier is an opinionated code formatter | 3.9.1 | MIT | dev | | typescript@^6.0.3 | TypeScript is a language for application scale JavaScript development | 6.0.3 | Apache-2.0 | dev | | vitest@^4.0.0 | Next generation testing framework powered by Vite | 4.1.9 | MIT | dev |
Options
- production (false) - include production dependencies
- dev (false) - include development dependencies
- optional (false) - include optional dependencies
- peer (false) - include peer dependencies
