Chalkboard NPM

Chalkboard.js

An npm package that generate better documentation

Dependencies

commander
wrench
marked
lodash

Example

#  
# @chalk overview  
# @name example  
# @description  
# This is an example description for an example in readme.  
# @param {String} name Just a random name  
# @param {Boolean} work Does this actually work?  
# @returns {String} Just another value  
#

TODO

TODO Wiki

Getting Started

The easiest way to use chalkboard will probably be to install it globally.

To do so, install the module with:

npm install -g chalkboard

Supported Tags

Wiki Page

Usage

Usage: chalkboard options
Options:
-h, --help output usage information
-V, --version output the version number
-o, --output DIR Documentation output file
-j, --join FILE Combine all documentation into one page
-f, --format TYPE Output format. Default to markdown
-p, --private Parse comments for private functions and varibles
-h, --header Only parse the first comment block