You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

38 lines
852 B

  1. # grunt-docco
  2. Grunt Docco plugin.
  3. ## Getting Started
  4. Install this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-docco`
  5. Then add this line to your project's `grunt.js` gruntfile:
  6. ```javascript
  7. grunt.loadNpmTasks('grunt-docco');
  8. ```
  9. [grunt]: https://github.com/cowboy/grunt
  10. [getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md
  11. ## Documentation
  12. ```
  13. docco: {
  14. debug: {
  15. src: ['test/**/*.js'],
  16. options: {
  17. output: 'docs/'
  18. }
  19. }
  20. }
  21. ```
  22. ## Contributing
  23. 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].
  24. ## Release History
  25. _(Nothing yet)_
  26. ## License
  27. Copyright (c) 2012 David Souther
  28. Licensed under the MIT license.