Beandocs - documentation engine for beanpole
Built-in templates
- WADL
- README files (use to generate docs online)
Live examples
Usage
beandocs -i /path/to/project -o /output/directory -t /template
Syntax
router
Example
Your beanpole file:
var router = ; router;
(optional) in your beanpole config located in same directory as package.json:
"title": "My Project Title" "descscription": "My Project Description" "template":"template name or template/path" "meta": "descriptions": "api": "Public to the world and over HTTP." "public": "api""public""http" "method" "pull": "Makes a request for current data." "push": "Called when data has changed."
in your console window:
beandocs -i /path/to/file