grunt-apidoc

Grunt task to generate a RESTful API Documentation with apidoc

npm install grunt-apidoc
25 downloads in the last day
141 downloads in the last week
629 downloads in the last month

grunt-apidoc

This plugin requires Grunt ~0.4.0

About

Generates a RESTful API Documentation with apiDoc.

Generated example documentation at http://apidocjs.com/example/

Installation

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

Configuration

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.
      • markged { 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
      }
    }
  }
}

Changelog

  • 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 https://github.com/apidoc/grunt-apidoc/pull/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.

License

Copyright (c) 2013 inveris OHG Author Peter Rottmann rottmann@inveris.de Licensed under the MIT license.

npm loves you