Skip to content

bendytree/explainjs

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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