gitdox v0.1.1

Gitdox is a tool that magically transform your JSDoc comments into a beautiful Github README file. It's inspired by the amazing API docs from the HapiJS team.

Instalation

Install with npm globally:

 $ npm install --global gitdox

or as development dependency:

 $ npm install --save-dev gitdox

Usage

Gitdox works as a CLI. Go to your project's root directory and use it by executing the gitdox command on the Terminal. Gitdox will look for a .gitdox.json configuration file - you can change the filename by using the --config option.

CLI Options

-c, --config [file]     Set config file
-o, --output [file]     Set output file
-i, --input [glob]      Comma-separated input file list
-b, --before [list]     Comma-separated list of md files to prepend to output
-a, --after [list]      Comma-separated list of md files to append to output
-co, --class-order      Order of classes on the output

Config file

The config file accepts the following options:

• out output file location default: README.md,
• in input file location list,
• before array of Markdown file locations to prepend to readme file,
• after array of Markdown file locations to append to readme file,
• classOrder Order of classes on the output