grunt-docco

KO | EN

gitlite — search

#python #typescript #llm #android #machine-learning #rust #deep-learning #linux #java #nodejs #cli #vue #pytorch #open-source

(★ 70)

Docco task for Grunt.

grunt-docco Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# grunt-docco

Grunt Docco plugin.

## Getting Started
Install this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-docco --save-dev`

Then add this line to your project's `grunt.js` gruntfile:

```javascript
grunt.loadNpmTasks('grunt-docco');
```

[grunt]: https://github.com/cowboy/grunt
[getting_started]: https://github.com/cowboy/grunt/blob/master/docs/getting_started.md

## Documentation

Add the task config to the grunt initConfig block.

```
docco: {
  debug: {
    src: ['test/**/*.js'],
    options: {
      output: 'docs/'
    }
  }
}

```

## 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][grunt].

## Release History
* 0.5.0: Support for grunt 1.0
* 0.4.0: Update to use docco ~0.7.0
* 0.3.3: Update to use latest official docco version
* 0.3.2: Update to use newer commit of development docco
* 0.3.1: Update to use #development docco - fixes several issues with multiple runs.
* 0.3.0: Removed dependency on python's pygments. Use latest libraries.
* 0.2.0: Early release, depended on python's pygments.

## License
Copyright (c) 2012 - 2016 David Souther et al
Licensed under the MIT license.

grunt-docco

grunt-docco Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

grunt-docco

grunt-docco Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README