1.0.0 • Published 9 years ago

metalsmith-mdast v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
9 years ago

metalsmith-mdast Build Status NPM version Dependency Status

Convert markdown to html with mdast.

If you have any issues with the output of this plugin, please use the mdast tracker.

Install

With npm do:

npm install metalsmith-mdast --save

Example

The mdast-html plugin is bundled for you automatically:

var mdast      = require('metalsmith-mdast'),
    Metalsmith = require('metalsmith');

Metalsmith('fixtures')
    .use(mdast())
    .build(function (err) {
        if (err) {
            throw err;
        }
    });

Add further plugins by passing an array:

var rmBadges   = require('mdast-strip-badges'),
    rmParas    = require('mdast-squeeze-paragraphs');

Metalsmith('fixtures')
    .use(mdast([ rmBadges, rmParas ]))
    .build(function (err) {
        if (err) {
            throw err;
        }
    });

Contributing

Pull requests are welcome. If you add functionality, then please add unit tests to cover it.

License

MIT © Ben Briggs