Skip to content

contentascode/metalsmith-remark-lint

Repository files navigation

metalsmith-remark Build Status NPM version Dependency Status

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

About

Lint markdown files using remark-lint

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •