forked from jashkenas/docco
-
Notifications
You must be signed in to change notification settings - Fork 5
Literate Programming can be Quick and Dirty.
License
GerHobbelt/docco
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
____ /\ _`\ \ \ \/\ \ ___ ___ ___ ___ \ \ \ \ \ / __`\ /'___\ /'___\ / __`\ \ \ \_\ \ /\ \ \ \ /\ \__/ /\ \__/ /\ \ \ \ \ \____/ \ \____/ \ \____\ \ \____\ \ \____/ \/___/ \/___/ \/____/ \/____/ \/___/ Docco is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. For more information, see: - Current Repo: https://github.com/GerHobbelt/docco - Original Repo: https://github.com/jashkenas/docco Installation ------------ sudo npm install -g gerhobbelt/docco Usage ----- Usage: docco [options] FILES Options: -h, --help output usage information -V, --version output the version number -l, --layout [layout] choose a built-in layouts (parallel, linear) -c, --css [file] use a custom css file -o, --output [path] use a custom output path -t, --template [file] use a custom .jst template -b, --blocks parse block comments where available -m, --markdown output markdown --marked [file] use custom marked options -k, --keepext [file] keep original file extension -i, --ignore [file] ignore unsupported languages -e, --extension [ext] use the given file extension for all inputs -L, --languages [file] use a custom languages.json --- For Docco Developers: Building and Testing ------------------------------------------ Install (on Ubuntu 12): ( as root ) apt-get install coffeescript ( as user ) npm install ( See also: harvesthq/chosen#508 ) cake.coffeescript build cake.coffeescript doc cake.coffeescript test When you run cake.coffeescript install you must make sure to install the commander package as well: npm install commander -g For Docco Developers: Building and Testing (original, outdated info): --------------------------------------------------------------------- npm install -g coffee-script npm install -g commander npm install make =================================================================== This fork supports JSDoc style comments and highlights declared parameters. Example: ``` /** * @description Lolify someone's name * @param {String} name A person's name */ function lolify(name) { return 'OH HAI ' + name + ' KTHXBAI'; } ```
About
Literate Programming can be Quick and Dirty.
Resources
License
Stars
Watchers
Forks
Packages 0
No packages published
Languages
- HTML 41.2%
- CSS 29.4%
- CoffeeScript 26.3%
- Makefile 1.2%
- Shell 1.0%
- C 0.2%
- Other 0.7%