node package manager
It’s your turn. Help us improve JavaScript. Take the 2017 JavaScript Ecosystem Survey »

doca-node-docson-theme

doca-node-docson-theme

Simple Node-Docson theme for doca, based on doca-bootstrap-theme.

It's supposed to be used in combination with doca - a tool that scaffolds API documentation based on JSON HyperSchemas.

Usage

npm install -g doca
doca init -t node-docson

This creates a new API documentation with doca-node-docson-theme as a dependency.

Special properties

The _schema property placed on an object or link schema will, if present, be passed to Node-Docson instead of the processed properties.

The _targetSchema property placed on a link schema will, if present, be passed to Node-Docson to document the schema for the response of the link. If this property is not set, the response schema will not be passed to Node-Docson, since targetSchema properties are not normally available to the theme.