docco-plus/README.md

Extending docco to work on multi-folder structures

[![Build Status](https://img.shields.io/travis/smravi/docco-plus.svg?style=flat-square)](https://travis-ci.org/smravi/docco-plus)
[![Code Climate](https://img.shields.io/codeclimate/github/smravi/docco-plus.svg?style=flat-square)](https://codeclimate.com/github/smravi/docco-plus)
[![Coverage Status](http://img.shields.io/coveralls/smravi/docco-plus.svg?style=flat-square)](https://coveralls.io/r/smravi/docco-plus)
[![Documentation](https://img.shields.io/badge/documentation-plus-green.svg?style=flat-square)](http://smravi.github.io/docco-plus/)

[![Dependency Status](https://img.shields.io/david/smravi/docco-plus.svg?style=flat-square)](https://david-dm.org/smravi/docco-plus)
[![devDependency Status](https://img.shields.io/david/dev/smravi/docco-plus.svg?style=flat-square)](https://david-dm.org/smravi/docco-plus#info=devDependencies)
[![peerDependency Status](https://img.shields.io/david/peer/smravi/docco-plus.svg?style=flat-square)](https://david-dm.org/smravi/docco-plus#info=peerDependencies)


# docco-plus

> docco-plus is an extension to [docco](http://jashkenas.github.io/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

```shell

sudo npm install -g docco-plus

```

### Usage

```shell

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](https://highlightjs.org/static/demo/)

 - `-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