chalkboard
Documentation generator for coffeescript
Last updated 6 years ago by adrianlee44 .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install chalkboard 
SYNC missed versions from official npm registry.

Chalkboard.js

Build Status
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] [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
-p, --private Parse comments for private functions and varibles
-h, --header Only parse the first comment block

Author

Adrian Lee (adrian@adrianlee.me)

Copyright and license

2014 Adrian Lee

MIT

Current Tags

  • 0.5.1                                ...           latest (6 years ago)

20 Versions

  • 0.5.1                                ...           6 years ago
  • 0.4.4                                ...           6 years ago
  • 0.4.3                                ...           6 years ago
  • 0.4.2                                ...           6 years ago
  • 0.4.1                                ...           7 years ago
  • 0.4.0                                ...           7 years ago
  • 0.3.0                                ...           7 years ago
  • 0.2.5                                ...           7 years ago
  • 0.2.4                                ...           7 years ago
  • 0.2.3                                ...           7 years ago
  • 0.2.2                                ...           7 years ago
  • 0.2.1                                ...           7 years ago
  • 0.2.0                                ...           7 years ago
  • 0.1.6                                ...           7 years ago
  • 0.1.5                                ...           7 years ago
  • 0.1.4                                ...           7 years ago
  • 0.1.3                                ...           7 years ago
  • 0.1.2                                ...           7 years ago
  • 0.1.1                                ...           7 years ago
  • 0.1.0                                ...           7 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (5)
Dev Dependencies (6)
Dependents (1)

Copyright 2014 - 2016 © taobao.org |