Skip to content
A JavaScript library that creates a side-by-side view of your code with your explanations.
JavaScript
Failed to load latest commit information.
node_modules added tests Apr 27, 2013
samples added tests Apr 27, 2013
test
.gitignore
.npmignore added tests Apr 27, 2013
LICENSE.txt Create LICENSE.txt Oct 30, 2014
index.js added linebreaks on jsdoc like properties May 14, 2013
package.json 0.0.9 May 14, 2013
readme.md Added the license to the readme Oct 30, 2014

readme.md

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

Something went wrong with that request. Please try again.