isabella232 / doc-generator

Auto-generate API docs for the video.js codebase and plugins

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.

Getting Started

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

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('videojs-doc-generator');

The "vjsdocs" task

Overview

In your project's Gruntfile, add a section named vjsdocs to the data object passed into grunt.initConfig().

grunt.initConfig({
  vjsdocs: {
    all: {
      // array of source paths
      src: ['src/file.js'],

      // output directory, default is 'docs'
      dest: 'docs/api'
      
      options: {
        // The location online where the source files live
        baseURL: 'https://github.com/videojs/video.js/blob/master/'
      }
    }
  }
})

Contributing

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.

Release History

(Nothing yet)

License

Copyright (c) 2013 Steve Heffernan. Licensed under the MIT license.