Markdown processor powered by plugins
The [remark][remark] processor is a markdown processor powered by
[plug-ins][plugins].
* Interface by [unified][unified]
* [MDAST][mdast] syntax tree
* Parses markdown to the tree with [remark-parse][parse]
* [Plug-ins][plugins] transform the tree
* Compiles the tree to markdown using [remark-stringify][stringify]
Don’t need the parser? Or the compiler? [That’s OK][unified-usage].
[npm][]:
``sh`
npm install remark
`js
var remark = require('remark');
var recommended = require('remark-preset-lint-recommended');
var html = require('remark-html');
var report = require('vfile-reporter');
remark()
.use(recommended)
.use(html)
.process('## Hello world!', function (err, file) {
console.error(report(err || file));
console.log(String(file));
});
`
Yields:
`txt
1:1 warning Missing newline character at end of file final-newline remark-lint
⚠ 1 warning
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://img.shields.io/travis/wooorm/remark.svg
[build-status]: https://travis-ci.org/wooorm/remark
[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/remark.svg
[coverage-status]: https://codecov.io/github/wooorm/remark
[chat-badge]: https://img.shields.io/gitter/room/wooorm/remark.svg
[chat]: https://gitter.im/wooorm/remark
[license]: https://github.com/wooorm/remark/blob/master/LICENSE
[author]: http://wooorm.com
[npm]: https://docs.npmjs.com/cli/install
[remark]: https://github.com/wooorm/remark
[unified]: https://github.com/wooorm/unified
[mdast]: https://github.com/wooorm/mdast
[parse]: https://github.com/wooorm/remark/blob/master/packages/remark-parse
[stringify]: https://github.com/wooorm/remark/blob/master/packages/remark-stringify
[plugins]: https://github.com/wooorm/remark/blob/master/doc/plugins.md
[unified-usage]: https://github.com/wooorm/unified#usage