Auto-generate markdown documentation using your package.json's dependencies
Auto-generate documentation using your package.json's dependencies
depdoc simply scans your package.json
's dependencies
property and returns some simple information about each item. For an example, please see this package's own depdoc.md.
npm install --global depdoc
Usage: depdoc <filepath> [options]
Options:
-h, --help output usage information
-V, --version output the version number
-g, --generate Generate a markdown file of the result
-p, --print Print result to the console
-c, --copy Copy result to clipboard
depdoc <filepath> -p
depdoc package.json -p
depdoc https://raw.githubusercontent.com/TryKickoff/generator-kickoff/master/package.json -p
Note: files hosted on github.com can also be used
depdoc <filepath> -c
depdoc package.json -c
depdoc https://raw.githubusercontent.com/TryKickoff/generator-kickoff/master/package.json -c
Default filename is depdoc.md
depdoc <filepath> -g
depdoc package.json -g dependencies
depdoc https://raw.githubusercontent.com/mrmartineau/depdoc/master/package.json -g dependencies
depdoc can also be used in your node code, but in order for your it to parse your json, you will need to normalise it first, see below for an example from the depdoc demo site.
var depdoc = require('depdoc');
var input = document.querySelector('.packageInput').value;
var normalisedInput = input.replace(/\r?\n|\s|\r/g,'');
var result = depdoc(input, 'json');