README.md

metalsmith-remark

Convert markdown to html with remark.

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

Install

With npm do:

npm install metalsmith-remark --save

Example

The remark-html plugin is bundled for you automatically:

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

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

Add further plugins by passing an array:

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

Metalsmith('fixtures')
    .use(remark([ 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