Skip to content

camacho/markdown-magic-dependency-table

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Dependency table

Add a table of dependencies to markdown files via markdown-magic

Install

npm i markdown-magic markdown-magic-dependency-table --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: {
    DEPENDENCYTABLE: require('./index.js'),
  },
};

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

Usage in markdown

Dependency Description Version License Type
find-up@^2.1.0 Find a file by walking up parent directories 2.1.0 MIT production
semver@^5.3.0 The semantic version parser used by npm. 5.7.1 ISC production
markdown-magic@>=0.1 <... Automatically update markdown files with content from external sources 2.6.0 MIT peer
prettier@^2.0.0 Prettier is an opinionated code formatter 2.6.1 MIT peer
markdown-magic@>=0.1 <... Automatically update markdown files with content from external sources 2.6.0 MIT dev
prettier@^2.0.0 Prettier is an opinionated code formatter 2.6.1 MIT dev

Options

  • production (false) - include production dependencies
  • dev (false) - include development dependencies
  • optional (false) - include optional dependencies
  • peer (false) - include peer dependencies

About

Render markdown of dependencies with information and links

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published