• Stars
    star
    247
  • Rank 164,117 (Top 4 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 11 years ago
  • Updated about 10 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A JavaScript library that creates a side-by-side view of your code with your explanations.

ExplainJS

Generate a side-by-side view of your comments and code. Works on JavaScript files, CSS, and other similar languages.

More info at http://www.explainjs.com

var explainjs = require('explainjs');

var js = '//My Library\n doSomething();';

explainjs(js, function(error, results){
  // <p>My Library</p>
  console.log(results.sections[0].comments);

  // doSomething();
  console.log(results.sections[0].code);
});

Here's how it looks:

ExplainJS Screenshot

Grunt

If you're looking for a Grunt plugin to automate this on your project, checkout grunt-explainjs.

License

MIT License