Skip to content
A JavaScript library that creates a side-by-side view of your code with your explanations.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
node_modules
samples
test
.gitignore
.npmignore
LICENSE.txt
index.js
package.json
readme.md

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

You can’t perform that action at this time.