- Notifications
You must be signed in to change notification settings - Fork0
Documentation javascript source code with comments in grunt task.
License
luozhihua/grunt-doxmate
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Doxmate grunt plugin to automatically generate documentation for you project. Currently generates JSON output usingdox, and generates HTML output usingdoxmate
This plugin requires Grunt~0.4.0
If you haven't usedGrunt before, be sure to check out theGetting Started guide, as it explains how to create aGruntfile 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 doxmate -g
npm install grunt-doxmate --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of #"auto" data-snippet-clipboard-copy-content="grunt.loadNpmTasks('grunt-doxmate');">
grunt.loadNpmTasks('grunt-doxmate');
Inside of your grunt file, add:
doxmate:{options:{title:"My Library's awesome documentation"},files:{src:['js/lib/'],dest:'docs'}},
This will run all of your files inlib through dox and doxmate and put the output indocs.
Since thegrunt-doxmate task is a multi task, you can create several tasks for doxmate:
doxmate:{libdocs :{files:{src:['js/lib/'],dest:'docs'}},sourcedocs :{files:{src:['js/src/'],dest:'docs'}}},
To ignore certain directories, or to override the default ignore list, simpy add ignore and an array of paths. Note that this is the same as passing the--ignore parameter as described on thedox-foundation docs:
--ignore <directories> Comma seperated list of directories to ignore. Overrides default of test, public, static, views, templatesUsage:
doxmate:{options:{title:'Ignore Nothing for my awesome documentation'},files:{ignore:['test'],src:['js/src/'],dest:'docs'}}
Note: This will completely delete and recreate the docs folder
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][grunt].
- 0.1.0: Initial release
Copyright (c) 2013 Colin LuoLicensed under the MIT license.
About
Documentation javascript source code with comments in grunt task.