FooDoc

FooDoc is a Bootstrap and Handlebars based template for JSDoc3. A big thanks must go out to DocStrap as it served as the inspiration for this project.

This project began as a simple modification of DocStrap. Removing the Bootswatch support in favor of my own CSS customizations but it ended up with me re-writing pretty much the entire template, even switching out the template engine to Handlebars.

Features

* Right side Table of Contents which auto hides on pages it's not required on.
* Basic themeing is supported through the systemColor option and if required further customizations can be supplied using the stylesheets and scripts options.
* Integrated offline search across all doclets and there members (excludes source files).
* Syntax highlighting using Prism .
* Breadcrumbs on every page for easy navigation.
* Handlebars template engine using precompiled templates to generate documentation.
* Extended tutorial configuration through the standard .json file approach supported by JSDoc allowing you to supply a structure as well as title and summary info for tutorials.
* Configurable navbar links including support for larger systems by switching to list pages with the inlineNav option instead of the usual drop downs.
* Responsive design, the generated documentation works across both desktop and mobile devices thanks to Bootstrap.
* Makes use of the JSDoc @summary tag where appropriate, this tag now also supports markdown syntax.

$3

As this started off as a DocStrap modification I've used it's fixtures code to generate the sample documentation so you can compare the differences between the two.

NOTE: The fixtures code doesn't make use of the @summary tag when describing it's members so it may look a little sparse.

* The default template options
* The template with the inlineNav option set to true
* The template using the systemLogo and systemColor options
* The template with the collapseSymbols option set to false

Ooooh, I want it! How do I get it?

If you manage your own version of jsdoc:

``bash
npm install foodoc
`

When using grunt, please look at grunt-jsdoc which you can use with FooDoc.

$3

`bash
jsdoc -c path/to/conf.json -t ./node_modules/foodoc/template -R README.md -r .
`

The -c sets the config, the options you can supply in the templates object are listed below in the options.

The -t sets the template. This is the option you need to set to get the FooDoc template to be used.

The -R sets a markdown file to be the front page of the documentation.

The -r tells jsdoc to run recursively.

The . says from current directory.

Configuring the template

FooDoc ships with a conf.json file in the template/ directory. It is just a regular old JSDoc configuration file, but with the following new options:

`javascript
"templates": {
"systemName" : "{string}",
"systemSummary" : "{string}",
"systemLogo" : "{string}",
"systemColor" : "{string}",
"footer" : "{string}",
"copyright" : "{string}",
"includeDate" : "{boolean}",
"dateFormat" : "{string}",
"inlineNav" : "{boolean}",
"inverseNav" : "{boolean}",
"navMembers" : "{array.