Git Product home page Git Product logo

grunt-docco's Introduction

grunt-docco

Grunt Docco plugin.

Getting Started

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

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

grunt.loadNpmTasks('grunt-docco');

Documentation

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

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

  • 0.3.4 [25.07.2013]: Use git+https protocol to avoid firewall issues for docco dependency
  • 0.3.3 [25.07.2013]: Instead of "0.6.2" bind to https://github.com/jashkenas/docco/commit/eb1163723a0ac04b0740d57b6b8a6d3bd4e5893f that fix windows integration issue
  • 0.3.2 [25.07.2013]: Assure the output dir exists, otherwise is created BEFORE calling docco (to avoid this issue on Windows calling 'mkdir')
  • 0.3.1 [24.07.2013]: Correctly set the Docco output using options.output or file.dest and fix docco.document() invocation (up to 0.3.1 the dest will be 'docs' anyway and invocation will result in odd error)

License

Copyright (c) 2012 David Souther
Licensed under the MIT license.

grunt-docco's People

Contributors

asaayers avatar bdougherty avatar davidsouther avatar devstonez avatar dfernandez79 avatar purge avatar

Watchers

 avatar  avatar  avatar

Forkers

devstonez

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.