A sample formatter for Toga documentation.
npm install toga-sampleNOTE: This project is under active development. APIs subject to change.
toga-sample[![NPM version][npm-img]][npm-url] [![Downloads][downloads-img]][npm-url] [![Build Status][travis-img]][travis-url] [![Coverage Status][coveralls-img]][coveralls-url] [![Chat][gitter-img]][gitter-url]
Walks a Toga abstract syntax tree, finds all samples, and compiles them into an iframed demo.
$ npm install toga-sample
``js
var toga = require('toga'),
js = require('toga-js'),
sample = require('toga-sample'),
pura = require('toga-pura'),
config = {
src: './src/assets/*/.js',
dest: './web/docs'
};
toga
.src(config.src)
.pipe(js.parser())
.pipe(sample.formatter())
.pipe(pura.compiler())
.pipe(toga.dest(config.dest));
``
[![Tasks][waffle-img]][waffle-url] [![Tip][gittip-img]][gittip-url]
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.
$ npm test
----
© 2015 Shannon Moeller
Licensed under MIT
[coveralls-img]: http://img.shields.io/coveralls/togajs/toga-sample/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/togajs/toga-sample
[downloads-img]: http://img.shields.io/npm/dm/toga-sample.svg?style=flat-square
[gitter-img]: http://img.shields.io/badge/gitter-join_chat-1dce73.svg?style=flat-square
[gitter-url]: https://gitter.im/togajs/toga
[gittip-img]: http://img.shields.io/gittip/shannonmoeller.svg?style=flat-square
[gittip-url]: https://www.gittip.com/shannonmoeller
[npm-img]: http://img.shields.io/npm/v/toga-sample.svg?style=flat-square
[npm-url]: https://npmjs.org/package/toga-sample
[travis-img]: http://img.shields.io/travis/togajs/toga-sample.svg?style=flat-square
[travis-url]: https://travis-ci.org/togajs/toga-sample
[waffle-img]: http://img.shields.io/github/issues/togajs/toga-sample.svg?style=flat-square
[waffle-url]: http://waffle.io/togajs/toga-sample