https://github.com/bendytree/explainjs

A JavaScript library that creates a side-by-side view of your code with your explanations.
https://github.com/bendytree/explainjs

Last synced: 3 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/bendytree/explainjs
• Owner: bendytree
• License: mit
• Created: 2013-04-26T16:59:44.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-10-30T13:41:48.000Z (about 10 years ago)
• Last Synced: 2024-10-09T19:35:11.566Z (about 1 month ago)
• Language: JavaScript
• Size: 537 KB
• Stars: 247
• Watchers: 10
• Forks: 17
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-starred - bendytree/explainjs - A JavaScript library that creates a side-by-side view of your code with your explanations. (others)

README

        

# 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){

	  // 
My Library

	  console.log(results.sections[0].comments);

	

	  // doSomething();

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

	});


Here's how it looks:

![ExplainJS Screenshot](http://www.explainjs.com/static/images/screenshot.jpg)

## Grunt

If you're looking for a [Grunt plugin](http://gruntjs.com) to automate this on your project, checkout [grunt-explainjs](https://github.com/collinforrester/grunt-explainjs).

## License

[MIT License](https://github.com/bendytree/explainjs/blob/master/LICENSE.txt)