Coder Social home page Coder Social logo

grunt-apidoc's Introduction


Build Status


Generates a RESTful API Documentation with apiDoc.

Generated example documentation at


  1. npm install grunt-apidoc --save-dev
  2. Add grunt.loadNpmTasks('grunt-apidoc'); to Gruntfile.js


Add the task to your Gruntfile's grunt.initConfig:

apidoc: {
  myapp: {
    src: "app/",
    dest: "apidoc/"

Use only one src and one dest, apiDoc search in subdirs for files with apidoc-parameters.

Additional options

All apiDoc options can be used within options-block, see apiDoc configure for details.

  • src: Source files directory.
  • dest: Destination directory, where the documentation will be created.
  • template: Directory with the template files.
  • options
    • includeFilters: [ ".*\.js$" ] RegEx, which files to parse.
    • debug: false Show Debug Output.
      • log: true Show Log Output.
      • simulate: false Simulation, no files will be written.
      • marked { gfm: true } marked (markdown) setting.

Example options:

includeFilters With includeFilters you can define which files apiDoc should include, default *.js.

debug Show verbose information.

apidoc: {
  mypp: {
    src: "app/",
    dest: "apidoc/",
    options: {
      debug: true,
      includeFilters: [ ".*\\.js$" ],
      excludeFilters: [ "node_modules/" ],
      marked: {
        gfm: true


  • 0.7.0 Upgrade to apiDoc 0.7.x.
  • 0.6.0 Upgrade to apiDoc 0.6.x.
  • 0.5.0 Upgrade to apiDoc 0.5.x.
  • 0.4.0 Upgrade to apiDoc 0.4.x.
  • 0.3.0 Upgrade to apiDoc 0.3.x.
  • 0.2.1 remove this.async() (Iolo apidoc#2)
  • 0.2.0 Upgrade to apiDoc 0.2.x.
  • 0.1.2 Grunt peer dependencies.
  • 0.1.1 Change binary Name.
  • 0.1.0 Initial release.


Please visit the main apiDoc project page on github for help and information.


Copyright (c) 2013-2014 inveris OHG

Author Peter Rottmann [email protected]

Licensed under the MIT license.

grunt-apidoc's People


iolo avatar loginx avatar rottmann avatar


 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.