https://github.com/amcmillan01/jsdoc2diagram

Create D3 Tree Diagram from your awesome jsdoc
https://github.com/amcmillan01/jsdoc2diagram

Last synced: about 1 month ago
JSON representation

Create D3 Tree Diagram from your awesome jsdoc

• Host: GitHub
• URL: https://github.com/amcmillan01/jsdoc2diagram
• Owner: amcmillan01
• License: mit
• Created: 2015-10-23T01:19:31.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-25T03:12:27.000Z (about 9 years ago)
• Last Synced: 2024-09-19T06:42:22.083Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 206 KB
• Stars: 42
• Watchers: 3
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-d3 - jsdoc2diagram - Create tree diagram from jsdoc (Miscellaneous)
• awesome-d3 - jsdoc2diagram - Create tree diagram from jsdoc (Miscellaneous)

README

        
## jsdoc2diagram

[![npm version](https://badge.fury.io/js/jsdoc2diagram.svg)](https://badge.fury.io/js/jsdoc2diagram)

[![Build Status](https://travis-ci.org/amcmillan01/jsdoc2diagram.svg?branch=master)](https://travis-ci.org/amcmillan01/jsdoc2diagram)

jsdoc2diagram is a [JSDoc](http://usejsdoc.org/) template that creates a [D3 tree diagram](http://bl.ocks.org/d3noob/8329404) 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.