A small node package parsing source code and generating simple documentation
@chalk overview
@name Chalkboard.js
@description
"Chalkboard is a documentation generator and it started as a generator for Coffeescript. Docco is great but it is very simple. This project took inspiration from JSDoc to parse Coffeescript better for documentation. Chalkboard allows user to indicate variable types, function parameters, return variables and much more.
Although it is originally written for parsing Coffeescript, it can be updated to parse other languages. Currently, it can generate documentation from Coffeescript and Javascript.
(quotes are only added around this block to make prettify render this better, it's not needed)"
@url https://github.com/adrianlee44/chalkboard
@license MIT
sudo npm install -g chalkboard
@chalk to the beginning of each comment blockchalkboard -j DOC.md src/
npm install grunt-chalkboard
Chalkboard's README is generated with Chalkboard
Usage: chalkboard [options] [FILES...]
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 (markdown | html)
-p, --private Parse comments for private functions and variables
-h, --header Only parse the first comment block
chalkboard = module.exports = {
parse,
compile,
format,
write,
processFiles,
configure
}