docco-central

Docco documentation for whole projects.

npm install docco-central
23 downloads in the last week
73 downloads in the last month

docco-central

Docco 0.4.0 documentation for whole projects.

Check out docco-central documenting itself.

Installation

npm install -g docco-central

Docco requires Pygments for syntax highlighting. Install it with sudo easy_install pygments or follow the installation documentation.

Usage

cd /path/to/your/project
docco-central lib/*.js

Documentation is put in docs by default.

Options

Usage: docco-central [options] <file>...

GENERAL OPTIONS
  -o, --output [path]      change the output directory ("docs" by default)
  -q, --quiet              silence console logs
  -h, --help               show usage information
  -V, --version            show version number

DOCCO OPTIONS
  -c, --css [file]       use a custom CSS file for Docco pages
  -t, --template [file]  use a custom .jst template for Docco pages

DOCCO CENTRAL OPTIONS
  -r, --readme [file]       change the readme file ("README.md" by default)
  -i, --indexReadme [file]  add content above the index (optional, "INDEX.md" by default)
  --title [string]          change the title and window title ("Doc Index" by default)
  --windowTitle [string]    change the window title (same as the title by default)

License (MIT)

Copyright (c) 2011 Alpha Hydrae

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you