Documentation generator for the Video.js codebase and plugins
npm install videojs-doc-generatorThe 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.
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:
``shell`
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:
`js`
grunt.loadNpmTasks('videojs-doc-generator');
to the data object passed into grunt.initConfig().`js
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/'
}
}
}
})
``