NOTE: This project is under active development. APIs subject to change.
toga
One tool and one destination for all project documentation including user guides, developer guides, styleguides, and api documentation for both front and back-end technologies. Source code for an entire project is streamed into documentation via Transform Streams a la gulp.
Install
Module:
$ npm install --save-dev toga
CLI:
$ npm install --global toga
Usage
Usage: toga [options]
Options:
-c, --config Specify configuration file [togafile.js]
-d, --cwd Specify working directory [.]
-h, --help Show help
-v, --version Show version number
API
var toga = ; // Loads toga. toga; // Just `require('vinyl-fs').src`.toga; // Just `require('vinyl-fs').dest`. toga; // Turns streams into tributaries of another.toga; // Turns a map function into a transform stream.toga; // Turns multiple readable streams into one.
togafile.js
Example Basic
var toga = css = js = md = pura = config = src: './src/docs/**/*.md' './src/assets/**/*.css' './src/assets/**/*.js' dest: './web/docs' ; toga ;
Advanced
var toga = css = js = perl = md = sample = pod = pura = config = manual: './README.md' './src/assets/docs/*.md' css: './src/assets/css/*.css' js: './src/assets/js/*.js' perl: './lib/**/*.{pl,pm}' dest: './web/docs' client = toga server = toga ; toga ;
Contribute
Standards for this project, including tests, code coverage, and semantics are enforced with a build tool. Pull requests must include passing tests with 100% code coverage and no linting errors.
Test
$ npm test
© 2015 Shannon Moeller me@shannonmoeller.com
Licensed under MIT