docco-plus
v2.0.2
Published
Extending docco to work on multi-folder structures
Downloads
56
Readme
docco-plus
docco-plus is an extension to docco with support for multiple folders and same file name with different extensions.
How to use
Installation and Setup
Install docco-plus globally using the command
sudo npm install -g docco-plus
Usage
docco-plus [options] FILES
FILES
can be a list of files or a glob pattern. When passing glob pattern make sure that they are enclosed by quotes.
Options:
Options available for docco-plus are listed below, These options do the same thing as docco options. In fact, they are passed as-is to the docco processor. Refer the Docco documentation on more details about these options.
-h
or--help
output usage information-V
or--version
output the version number-c [file]
or--css [file]
use a custom css file-h [string]
or--highlightStyle [string]
use a highlightjs theme style. Styles are detailed here-o [path]
or--output [path]
use a custom output path-L [file]
or--languages [file]
use a custom languages.json-t [path]
or--template [path]
use a custom jst template file-m [file]
or--marked [file]
use custom marked options-i [file]
or--index [file]
the file to be documented as the landing file for the documentation