Skip to content

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

License

Notifications You must be signed in to change notification settings

bendytree/explainjs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published