Video.js Doc Generator
The Video.js Doc Generator reads source files and generates markdown docs. It relies on a combination of AST parsing (using esprima) and JSDoc-style tags.
The doc generator is primarily used as a Grunt plugin.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install videojs-doc-generator --save-dev
The "vjsdocs" task
In your project's Gruntfile, add a section named
vjsdocs to the data object passed into
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Copyright (c) 2013 Steve Heffernan. Licensed under the MIT license.