Code Monkey home page Code Monkey logo

grunt-doccoh's Introduction

grunt-doccoh

Grunt Doccoh plugin. Use Doccoh instead of Docco.

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-doccoh

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

grunt.loadNpmTasks('grunt-doccoh');

Config Examples

There are two formats you can use to run this task.

Short
doccoh: {
  src: ['*js', 'path1/**/*js', 'path2/**/*js']
}```

##### Long (specific targets with optional target options)

``` javascript
doccoh: {
  app: {
    src: ['*js', 'path1/**/*js', 'path2/**/*js'],
    options: {
      output: 'dir'
    }
  }
}

Parameters

src string | array

This defines which files will be documented.

options object

Docco options:

  • css file use a custom css file
  • output path use a custom output path
  • template file use a custom .jst template

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.

Release History

  • 2012/10/29 - v0.1.3 - Renamed from grunt-docco to grunt-doccoh. Enhanced documentation. Use doccoh instead of docco.

License

Licensed under the MIT license.

grunt-doccoh's People

Contributors

davidsouther avatar ahmednuaman avatar rozmiarek avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.