toga-markdown

1.0.0 • Public • Published

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

toga-markdown

NPM version Downloads Build Status Coverage Status Chat Tip

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

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

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

Package Sidebar

Install

npm i toga-markdown

Weekly Downloads

2

Version

1.0.0

License

MIT

Last publish

Collaborators

  • shannonmoeller