{"_id":"grunt-dox","_rev":"28-da020eaef7634bb43d6ed6af4ac0f91c","name":"grunt-dox","description":"Dox grunt plugin","dist-tags":{"latest":"0.5.0"},"versions":{"0.1.0":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.1.0","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt test"},"dependencies":{"dox":"*","dox-template":"*"},"devDependencies":{"grunt":"~0.3.15"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin\n\n## Getting Started\nInstall this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-dox`\n\nThen add this line to your project's `grunt.js` gruntfile:\n\n```javascript\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n[grunt]: https://github.com/cowboy/grunt\n[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md\n\n## Documentation\n_(Coming soon)_\n\n## Contributing\nIn 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].\n\n## Release History\n_(Nothing yet)_\n\n## License\nCopyright (c) 2012 Matt McManus \nLicensed under the MIT license.\n","_id":"grunt-dox@0.1.0","dist":{"shasum":"29092b33624ad76ac689a4bab85b52eb74a07fa2","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.1.0.tgz","integrity":"sha512-3dOF3lRKB6gk9cWQyPdOGoGI9A/X839ntLTWdnPF9UzXANROJR8PW1eTVqgCPKFGKvKXPavARZ+JMS8mWo3F+w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDaMxePW+bnLBzXTGimg6qO/7dKVSBkVluGa/Qn5pDxDAIhAI+9J2LQuT8wXrX0y+07Oh1IRZ9UACI4lYeHITX+HY+o"}]},"_npmVersion":"1.1.61","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}],"directories":{}},"0.2.0":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.2.0","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt test"},"dependencies":{"dox":"*","dox-foundation":"*","rimraf":"2.x"},"devDependencies":{"grunt":"~0.3.15"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using [dox-foundaiton](https://github.com/punkave/dox-foundation)\n\n## Getting Started\nInstall this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-dox`\n\nThen add this line to your project's `grunt.js` gruntfile:\n\n```javascript\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n[grunt]: https://github.com/cowboy/grunt\n[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md\n\n## Documentation\nInside of your grunt file, add:\n```javascript\ndox: {\n files: {\n src: ['dir/*', '*.js'],\n dest: 'docs'\n }\n},\n```\n\nThis will run all of your files through dox and dox-foundation and created a file `docs/api.html`\n\n**Note:** This will completely deleter and recreate the docs folder\n\n## Contributing\nIn 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].\n\n## Release History\n* **0.1.0**: Initial release\n* **0.2.0**: Pass multiple files at once. Use dox-foundation for html output\n\n## License\nCopyright (c) 2012 P'unk Ave\nLicensed under the MIT license.\n","_id":"grunt-dox@0.2.0","dist":{"shasum":"debdf36c6d71970a7fbd8ef113f74c8bb1da4162","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.2.0.tgz","integrity":"sha512-LB8eIkoiJFdSv7EXUUTlGoW9DBNqgLhSkkpc++oAJ/c50YxeZv1fClGLVikdujvpq4i3iIETA1Q1qxHYS1uVXw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICGVH7iXQLNsOfazF05LhTnQC6A4gMdbXIKhqSNDmAD+AiEAz+wzgENva5c4/uD8DePlFkWI4ItJz6csvoaKdBsyocM="}]},"_npmVersion":"1.1.61","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}]},"0.2.1":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.2.1","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt test"},"dependencies":{"dox":"*","dox-foundation":"0.2.x","rimraf":"2.x"},"devDependencies":{"grunt":"~0.3.15"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using [dox-foundaiton](https://github.com/punkave/dox-foundation)\n\n## Getting Started\nInstall this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-dox`\n\nThen add this line to your project's `grunt.js` gruntfile:\n\n```javascript\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n[grunt]: https://github.com/cowboy/grunt\n[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md\n\n## Documentation\nInside of your grunt file, add:\n```javascript\ndox: {\n files: {\n src: ['dir/*', '*.js'],\n dest: 'docs'\n }\n},\n```\n\nThis will run all of your files through dox and dox-foundation and created a file `docs/api.html`\n\n**Note:** This will completely deleter and recreate the docs folder\n\n## Contributing\nIn 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].\n\n## Release History\n* **0.1.0**: Initial release\n* **0.2.0**: Pass multiple files at once. Use dox-foundation for html output\n\n## License\nCopyright (c) 2012 P'unk Ave\nLicensed under the MIT license.\n","readmeFilename":"README.md","_id":"grunt-dox@0.2.1","dist":{"shasum":"b33d87702b5456f7cc18944c7bf3c0dbd21daeb7","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.2.1.tgz","integrity":"sha512-DQskvx7NeWpi4/KT+2Ol5emZbsdbh1LvNuAxkMPTbUI2V9Qcy1/jwNXM3lF7bp0PJOsifklgGLc83QIxvWzuyg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD4DkTktX2tNqaMxi3M7jRUlY0onq8nS8XvkTEpVdDmrAIgDfM9XhfR+US857vILTqLkExo58LcUX7x/FH6I0HJoJQ="}]},"_npmVersion":"1.1.68","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}]},"0.2.2":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.2.2","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt test"},"dependencies":{"dox":"*","dox-foundation":"0.2.x","rimraf":"2.x"},"devDependencies":{"grunt":"~0.3.15"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using [dox-foundaiton](https://github.com/punkave/dox-foundation)\n\n## Getting Started\nInstall this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-dox`\n\nThen add this line to your project's `grunt.js` gruntfile:\n\n```javascript\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n[grunt]: https://github.com/cowboy/grunt\n[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md\n\n## Documentation\nInside of your grunt file, add:\n```javascript\ndox: {\n files: {\n src: ['dir/*', '*.js'],\n dest: 'docs'\n }\n},\n```\n\nThis will run all of your files through dox and dox-foundation and created a file `docs/api.html`\n\n**Note:** This will completely deleter and recreate the docs folder\n\n## Contributing\nIn 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].\n\n## Release History\n* **0.1.0**: Initial release\n* **0.2.0**: Pass multiple files at once. Use dox-foundation for html output\n\n## License\nCopyright (c) 2012 P'unk Ave\nLicensed under the MIT license.\n","readmeFilename":"README.md","_id":"grunt-dox@0.2.2","dist":{"shasum":"b16246a4bc7de13fad53f7b6ff21dd18a4692229","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.2.2.tgz","integrity":"sha512-d5vT2GLc2KSfQBYyFxmm2T1uGvY0EqTvxhOipGHBs9/y81d3Pxr0MUeGGdYbIrCi+Lw1Q2OzFLUNL2MUvJleAw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD2OSy98vswhu5LwS5Y2bjwBg91n9UciawbDfO4+fFflAIgXi57vbGqaUClDSbtRadxTTmLxQhVtpleW9xI6az2C5g="}]},"_npmVersion":"1.1.68","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}]},"0.3.0":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.3.0","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt test"},"dependencies":{"dox":"*","dox-foundation":"0.4.x","rimraf":"2.x"},"devDependencies":{"grunt":"~0.3.15"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using [dox-foundaiton](https://github.com/punkave/dox-foundation)\n\n## Getting Started\nInstall this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-dox`\n\nThen add this line to your project's `grunt.js` gruntfile:\n\n```javascript\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n[grunt]: https://github.com/cowboy/grunt\n[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md\n\n## Documentation\nInside of your grunt file, add:\n```javascript\ndox: {\n files: {\n src: ['lib/**/*.js'],\n dest: 'docs'\n }\n},\n```\n\nThis will run all of your files through dox and dox-foundation and put the output in `docs`\n\n**Note:** This will completely delete and recreate the docs folder\n\n## Contributing\nIn 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].\n\n## Release History\n* **0.1.0**: Initial release\n* **0.2.0**: Pass multiple files at once. Use dox-foundation for html output\n* **0.3.0**: Now relies solely on folder parsing done by dox-foundation v0.4\n\n## License\nCopyright (c) 2012 P'unk Ave\nLicensed under the MIT license.\n","readmeFilename":"README.md","_id":"grunt-dox@0.3.0","dist":{"shasum":"2564a9b6f4ed990e6d44b19009002b477d8d76cf","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.3.0.tgz","integrity":"sha512-tdXpi2bf5Gy2RmyA+kiU4P5R83CU6KKMRLtz/dnGPU1fg3Tldr2hfG5vX/mzsQ0Oi6IuiF1sUo5Sqkxe+wrghg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCNGECqSKsTF/hTtwURh+PKpHQ54bPMUcYWYrQpbka2KgIgF3EOGMUBV5UPmFyGvSx0/5A8bkYpiTAFh/D5uvQyCTg="}]},"_npmVersion":"1.2.0","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}]},"0.3.1":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.3.1","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt test"},"dependencies":{"dox":"*","dox-foundation":"0.4.x","rimraf":"2.x"},"devDependencies":{"grunt":"~0.3.15"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using [dox-foundaiton](https://github.com/punkave/dox-foundation)\n\n## Getting Started\nInstall this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-dox`\n\nThen add this line to your project's `grunt.js` gruntfile:\n\n```javascript\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n[grunt]: https://github.com/cowboy/grunt\n[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md\n\n## Documentation\nInside of your grunt file, add:\n```javascript\ndox: {\n files: {\n src: ['lib/**/*.js'],\n dest: 'docs'\n }\n},\n```\n\nThis will run all of your files through dox and dox-foundation and put the output in `docs`\n\n**Note:** This will completely delete and recreate the docs folder\n\n## Contributing\nIn 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].\n\n## Release History\n* **0.1.0**: Initial release\n* **0.2.0**: Pass multiple files at once. Use dox-foundation for html output\n* **0.3.0**: Now relies solely on folder parsing done by dox-foundation v0.4\n\n## License\nCopyright (c) 2012 P'unk Ave\nLicensed under the MIT license.\n","readmeFilename":"README.md","_id":"grunt-dox@0.3.1","dist":{"shasum":"7fa96301f0aac46ef96bead4df44a543f3b6e2ba","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.3.1.tgz","integrity":"sha512-dnCBpdqq0Xfgd9uj3liPk7KWKZ6zPXuiWvbYxiwcSA2TgqdoHTS5HJTyWDeLCM1YxMUWFieISxjYswGhjAQOjw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICkD2SThUVAg/vbaX5Rmcd+052vDbuhlvmrm8bIApzMQAiEAqAh+uCitPy72KBYSaJte8TP6KSSY26grXQaRI9oRUHU="}]},"_npmVersion":"1.2.0","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}]},"0.4.0":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.4.0","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt nodeunit"},"dependencies":{"dox":"*","dox-foundation":"0.2.x","rimraf":"2.x"},"devDependencies":{"grunt":"~0.4.0","grunt-contrib-jshint":"~0.1.1","grunt-contrib-watch":"~0.2.0","grunt-contrib-nodeunit":"~0.1.2"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using [dox-foundaiton](https://github.com/punkave/dox-foundation)\n\n## Getting Started\nThis plugin requires Grunt `~0.4.0`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-dox --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n## Documentation\nInside of your grunt file, add:\n```javascript\ndox: {\n options: {\n title: \"My Library's awesome documentation\"\n },\n files: {\n src: ['js/lib/'],\n dest: 'docs'\n }\n},\n```\n\nThis will run all of your files in `lib` through dox and dox-foundation and put the output in `docs`.\n\nSince the `grunt-dox` task is a multi task, you can create several tasks for dox:\n\n```js\ndox: {\n libdocs :{\n files: {\n src: ['js/lib/'],\n dest: 'docs'\n }\n },\n sourcedocs :{\n files: {\n src: ['js/src/'],\n dest: 'docs'\n }\n }\n},\n```\n\n**Note:** This will completely delete and recreate the docs folder\n\n## Contributing\nIn 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].\n\n## Release History\n* **0.3.2** *2013-03-20*: \n** Grunt v0.4 support\n** Ability to pass options.title to dox-foundation\n* **0.3.0**: Now relies solely on folder parsing done by dox-foundation v0.4\n* **0.2.0**: Pass multiple files at once. Use dox-foundation for html output\n* **0.1.0**: Initial release\n\n## License\nCopyright (c) 2012 P'unk Ave\nLicensed under the MIT license.\n","readmeFilename":"README.md","_id":"grunt-dox@0.4.0","dist":{"shasum":"e13887620a3b6d33a4c0b6152a2304f991196b44","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.4.0.tgz","integrity":"sha512-DJfXsfdqgeCxefPhvFE7+tOyGhvai7i6uVQpvAuASKecqoN56G7UlC+M23AWo25QK44f1lvfxHf40pqHcPj1/A==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCE9O1wSYuXb+XLhIpUcIdi+M5uYeN0Hw/rGZXdE2nMyQIhAOVA/AuGjnNXQsUB2YXYCYt3VGoOFPQuGAvicZt5lMoc"}]},"_from":".","_npmVersion":"1.2.14","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}]},"0.4.1":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.4.1","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt nodeunit"},"dependencies":{"dox":"*","dox-foundation":"~0.4.7","rimraf":"2.x"},"devDependencies":{"grunt":"~0.4.0","grunt-contrib-jshint":"~0.1.1","grunt-contrib-watch":"~0.2.0","grunt-contrib-nodeunit":"~0.1.2"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using [dox-foundaiton](https://github.com/punkave/dox-foundation)\n\n## Getting Started\nThis plugin requires Grunt `~0.4.0`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-dox --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n## Documentation\nInside of your grunt file, add:\n```javascript\ndox: {\n options: {\n title: \"My Library's awesome documentation\"\n },\n files: {\n src: ['js/lib/'],\n dest: 'docs'\n }\n},\n```\n\nThis will run all of your files in `lib` through dox and dox-foundation and put the output in `docs`.\n\nSince the `grunt-dox` task is a multi task, you can create several tasks for dox:\n\n```js\ndox: {\n libdocs :{\n files: {\n src: ['js/lib/'],\n dest: 'docs'\n }\n },\n sourcedocs :{\n files: {\n src: ['js/src/'],\n dest: 'docs'\n }\n }\n},\n```\n\n**Note:** This will completely delete and recreate the docs folder\n\n## Contributing\nIn 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].\n\n## Release History\n* **0.3.2** *2013-03-20*: \n** Grunt v0.4 support\n** Ability to pass options.title to dox-foundation\n* **0.3.0**: Now relies solely on folder parsing done by dox-foundation v0.4\n* **0.2.0**: Pass multiple files at once. Use dox-foundation for html output\n* **0.1.0**: Initial release\n\n## License\nCopyright (c) 2012 P'unk Ave\nLicensed under the MIT license.\n","readmeFilename":"README.md","_id":"grunt-dox@0.4.1","dist":{"shasum":"7f23dd3069761c279fa5734229ca9fa764eda95e","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.4.1.tgz","integrity":"sha512-HdiqweLKkbQyVBa8pQoq2vhjfcJbA9oof3cdXFGCYVmoR4Es1vm8svzZ3nvLa/fsRzZhxP+Ey5rxEpZDe+ZuIA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC+baNIGGOSwasRmdFGf+yNZ/b1kc0lxa/4eLBF5F9QJwIgX2YH1nHTTuGBdTh4IC8Nhdo610h3orVGouGqsupACfU="}]},"_from":".","_npmVersion":"1.2.14","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}]},"0.4.2":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.4.2","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt nodeunit"},"dependencies":{"dox":"*","dox-foundation":"~0.4.7","rimraf":"2.x"},"devDependencies":{"grunt":"~0.4.0","grunt-contrib-jshint":"~0.1.1","grunt-contrib-watch":"~0.2.0","grunt-contrib-nodeunit":"~0.1.2"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using [dox-foundaiton](https://github.com/punkave/dox-foundation)\n\n## Getting Started\nThis plugin requires Grunt `~0.4.0`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-dox --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n## Documentation\nInside of your grunt file, add:\n```javascript\ndox: {\n options: {\n title: \"My Library's awesome documentation\"\n },\n files: {\n src: ['js/lib/'],\n dest: 'docs'\n }\n},\n```\n\nThis will run all of your files in `lib` through dox and dox-foundation and put the output in `docs`.\n\nSince the `grunt-dox` task is a multi task, you can create several tasks for dox:\n\n```js\ndox: {\n libdocs :{\n files: {\n src: ['js/lib/'],\n dest: 'docs'\n }\n },\n sourcedocs :{\n files: {\n src: ['js/src/'],\n dest: 'docs'\n }\n }\n},\n```\n\nTo 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 the [dox-foundation docs](https://github.com/punkave/dox-foundation/blob/master/README.md):\n\n```\n--ignore Comma seperated list of directories to ignore. Overrides default of test, public, static, views, templates\n```\n\nUsage:\n\n```js\ndox: {\n options: {\n title: 'Ignore Nothing for my awesome documentation'\n },\n files: {\n ignore: ['test'],\n src: ['js/src/'],\n dest: 'docs'\n }\n}\n```\n\n**Note:** This will completely delete and recreate the docs folder\n\n## Contributing\nIn 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].\n\n## Release History\n* **0.3.2** *2013-03-20*: \n** Grunt v0.4 support\n** Ability to pass options.title to dox-foundation\n* **0.3.0**: Now relies solely on folder parsing done by dox-foundation v0.4\n* **0.2.0**: Pass multiple files at once. Use dox-foundation for html output\n* **0.1.0**: Initial release\n\n## License\nCopyright (c) 2012 P'unk Ave\nLicensed under the MIT license.\n","readmeFilename":"README.md","_id":"grunt-dox@0.4.2","dist":{"shasum":"18a864236e02b8131f9541094a10bc916a94f5fb","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.4.2.tgz","integrity":"sha512-v1tjGthw9KnrV2KBl3Ujax/gRQMQymnp4QaId2GhfPxn2FdsMMcWuSNgtlz+xWRF2aYsr/XPwdVShnV1NOMtJA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDkxWg13EU2DEKwjGNDHDfp5U6rLCH4/SX6Vx2/PLzZHQIhAKGtJiXF9Rx+SjpZmSpIJtIVcWFitnLAZKHx6ToScLm3"}]},"_from":".","_npmVersion":"1.2.21","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}]},"0.5.0":{"name":"grunt-dox","description":"Dox grunt plugin","version":"0.5.0","homepage":"https://github.com/mattmcmanus/grunt-dox","author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"bugs":{"url":"https://github.com/punkave/grunt-dox/issues"},"licenses":[{"type":"MIT","url":"https://github.com/punkave/grunt-dox/blob/master/LICENSE-MIT"}],"main":"grunt.js","bin":{"grunt-dox":"bin/grunt-dox"},"engines":{"node":"*"},"scripts":{"test":"grunt nodeunit"},"dependencies":{"dox":"*","dox-foundation":"~0.5.0","rimraf":"2.x"},"devDependencies":{"grunt":"~0.4.0","grunt-contrib-jshint":"~0.1.1","grunt-contrib-watch":"~0.2.0","grunt-contrib-nodeunit":"~0.1.2"},"keywords":["gruntplugin"],"readme":"# grunt-dox\n\nDox grunt plugin to automatically generate documentation for you project. Currently generates HTML output using [dox-foundaiton](https://github.com/punkave/dox-foundation)\n\n## Getting Started\nThis plugin requires Grunt `~0.4.0`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-dox --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n## Documentation\nInside of your grunt file, add:\n```javascript\ndox: {\n options: {\n title: \"My Library's awesome documentation\"\n },\n files: {\n src: ['js/lib/'],\n dest: 'docs'\n }\n},\n```\n\nThis will run all of your files in `lib` through dox and dox-foundation and put the output in `docs`.\n\nSince the `grunt-dox` task is a multi task, you can create several tasks for dox:\n\n```js\ndox: {\n libdocs :{\n files: {\n src: ['js/lib/'],\n dest: 'docs'\n }\n },\n sourcedocs :{\n files: {\n src: ['js/src/'],\n dest: 'docs'\n }\n }\n},\n```\n\nTo 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 the [dox-foundation docs](https://github.com/punkave/dox-foundation/blob/master/README.md):\n\n```\n--ignore Comma seperated list of directories to ignore. Overrides default of test, public, static, views, templates\n```\n\nUsage:\n\n```js\ndox: {\n options: {\n title: 'Ignore Nothing for my awesome documentation'\n },\n files: {\n ignore: ['test'],\n src: ['js/src/'],\n dest: 'docs'\n }\n}\n```\n\n**Note:** This will completely delete and recreate the docs folder\n\n## Contributing\nIn 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].\n\n## Release History\n* **0.3.2** *2013-03-20*: \n** Grunt v0.4 support\n** Ability to pass options.title to dox-foundation\n* **0.3.0**: Now relies solely on folder parsing done by dox-foundation v0.4\n* **0.2.0**: Pass multiple files at once. Use dox-foundation for html output\n* **0.1.0**: Initial release\n\n## License\nCopyright (c) 2012 P'unk Ave\nLicensed under the MIT license.\n","readmeFilename":"README.md","_id":"grunt-dox@0.5.0","dist":{"shasum":"bad0714be3843b02c766500ba2164a2f42197fb7","tarball":"https://registry.npmjs.org/grunt-dox/-/grunt-dox-0.5.0.tgz","integrity":"sha512-kO9KPizGGna6Mt/Yy1uswRXddm0dUYsfqD26ZgwK9HL8WesoQqvwRYQkopPL2OvwDlNEQNbiTFpM3CCc0hmO5w==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCUaPQmQu3iDJZN6gfa+yYrPrUUqIhwWGLEekRSlAsUkgIhANzw9OtNYhxU5NoD+UIdhRXVMfKHzFcY6XHgXj1TQoQo"}]},"_from":".","_npmVersion":"1.2.25","_npmUser":{"name":"mattmcmanus","email":"mcmanus@punkave.com"},"maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}]}},"readme":"# grunt-dox\n\nDox grunt plugin\n\n## Getting Started\nInstall this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-dox`\n\nThen add this line to your project's `grunt.js` gruntfile:\n\n```javascript\ngrunt.loadNpmTasks('grunt-dox');\n```\n\n[grunt]: https://github.com/cowboy/grunt\n[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md\n\n## Documentation\n_(Coming soon)_\n\n## Contributing\nIn 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].\n\n## Release History\n_(Nothing yet)_\n\n## License\nCopyright (c) 2012 Matt McManus \nLicensed under the MIT license.\n","maintainers":[{"name":"mattmcmanus","email":"mcmanus@punkave.com"}],"time":{"modified":"2022-06-18T14:53:39.518Z","created":"2012-09-14T20:22:11.308Z","0.1.0":"2012-09-14T20:22:11.723Z","0.2.0":"2012-09-28T21:27:18.194Z","0.2.1":"2012-12-30T00:51:39.097Z","0.2.2":"2012-12-30T00:55:31.089Z","0.3.0":"2013-01-29T03:49:27.423Z","0.3.1":"2013-01-29T14:43:39.426Z","0.4.0":"2013-03-21T02:23:10.457Z","0.4.1":"2013-03-21T13:17:47.095Z","0.4.2":"2013-05-24T15:12:43.519Z","0.5.0":"2013-07-06T13:32:34.665Z"},"author":{"name":"Matt McManus","email":"mcmanus@punkave.com"},"repository":{"type":"git","url":"git://github.com/punkave/grunt-dox.git"},"users":{"phun-ky":true}}