@azu/docco
The Quick and Dirty Literate Programming Documentation Generator
Last updated 3 years ago by azu .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @azu/docco 
SYNC missed versions from official npm registry.

/\ \ \ \ \/\ \ ___ ___ ___ ___ \ \ \ \ \ / __\ /'__\ /'_\ / __`
\ \ _\ \ /\ \ \ \ /\ _
/ /\ _
/ /\ \ \
\ ____/ \ ____/ \ ____\ \ ____\ \ __/ // // // // /___/

Docco is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator. For more information, see:

Installation

npm install -g @azu/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
-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: https://github.com/harvesthq/chosen/issues/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';
}

Current Tags

  • 0.7.2                                ...           latest (3 years ago)

1 Versions

  • 0.7.2                                ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 2
Last Day 0
Last Week 2
Last Month 8
Dependencies (5)
Dev Dependencies (3)
Dependents (0)
None

Copyright 2014 - 2017 © taobao.org |