README.md

October 25, 2015 ยท View on GitHub

jsdoc2diagram

npm version Build Status

jsdoc2diagram is a JSDoc template that creates a D3 tree diagram from your code's jsdoc documentation.

Code

Diagram

Getting Started

  • npm install jsdoc
  • npm install jsdoc2diagram
  • jsdoc -t PATH/TO/jsdoc2diagram -r JS_SOURCE_DIR/FILE -d OUTPUT_DIR

Reference

  • http://usejsdoc.org/
  • http://bl.ocks.org/d3noob/8329404

License

Licensed under The MIT License (MIT)

For the full copyright and license information, please view the LICENSE.txt file.

Contents

  1. 1jsdoc2diagram
  2. 1.1Getting Started
  3. 1.2Reference
  4. 1.3License