Consoul
Consoul is a markdown renderer for the terminal. You might say it adds some soul to your console? I'm so sorry.
Usage
var consoul = require('consoul');
process.stdout.write(consoul.fromFileSync('./EXAMPLE.md'));
consoul.fromFile('./EXAMPLE.md', function (err, output) {
process.stdout.write(output);
});
process.stdout.write(consoul.fromString('# Hello World!'));
Output:
![Screenshot](http://grimhappy.com/i/b13fcd7.png)
Why?
We wanted to write markdown documentation for our grunt tasks. We wanted to be able to display that documentation when running grunt help
. Whatevs.
How?
Consoul uses the marked Markdown parser. It overrides a few methods to render console appropriate stuff instead of HTML. It uses a (hacked!) version of highlight.js to do the syntax highlighting.
TODO