Consoul is a markdown renderer for the terminal. You might say it adds some soul to your console? I'm so sorry.
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!'));
We wanted to write markdown documentation for our grunt tasks. We wanted to be able to display that documentation when running grunt help. Whatevs.
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.
FAQs
Markdown in your console
The npm package consoul receives a total of 0 weekly downloads. As such, consoul popularity was classified as not popular.
We found that consoul demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.