NOTE: This project is under active development. APIs subject to change.

toga-markdown

[![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] [![Tip][amazon-img]][amazon-url]

Walks a Toga abstract syntax tree, finds all block and tag descriptions, parses them as Markdown, and replaces the values with the HTML output.

Install

$ npm install toga-markdown

Usage

``js
var toga = require('toga'),
js = require('toga-js'),
md = require('toga-markdown'),
pura = require('toga-pura'),

config = {
src: './src/assets/*/.js',
dest: './web/docs'
};

toga
.src(config.src)
.pipe(js.parser())
.pipe(md.formatter())
.pipe(pura.compiler())
.pipe(toga.dest(config.dest));
``

Contribute

[![Tasks][waffle-img]][waffle-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.

$3

$ npm test

----

© 2015 Shannon Moeller

Licensed under MIT

[amazon-img]: https://img.shields.io/badge/amazon-tip_jar-yellow.svg?style=flat-square
[amazon-url]: https://www.amazon.com/gp/registry/wishlist/1VQM9ID04YPC5?sort=universal-price
[coveralls-img]: http://img.shields.io/coveralls/togajs/toga-markdown/master.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/togajs/toga-markdown
[downloads-img]: http://img.shields.io/npm/dm/toga-markdown.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
[npm-img]: http://img.shields.io/npm/v/toga-markdown.svg?style=flat-square
[npm-url]: https://npmjs.org/package/toga-markdown
[travis-img]: http://img.shields.io/travis/togajs/toga-markdown.svg?style=flat-square
[travis-url]: https://travis-ci.org/togajs/toga-markdown
[waffle-img]: http://img.shields.io/github/issues/togajs/toga-markdown.svg?style=flat-square
[waffle-url]: http://waffle.io/togajs/toga-markdown