grunt-citare-scriptum

0.0.1 • Public • Published

grunt-citare-scriptum

A simple grunt task to generate a project's documentation using citare-scriptum

Build Status

This is pretty much grunt-groc, with some variables/strings referencing groc renamed to citare-scriptum.

Usage

Install this plugin with the following command:

npm install grunt-citare-scriptum --save-dev

Load the plugin in your Gruntfile.js:

grunt.loadNpmTasks('grunt-citare-scriptum');

Running grunt citare-scriptum:javascript (or grunt citare-scriptum since citare-scriptum is a multitask) will generate documentation for the specified files.

// Project configuration.
grunt.initConfig({
  citare-scriptum: {
    javascript: [
      "tasks/*.js", "README.md"
    ],
    options: {
      "out": "doc/"
    }
  }
});

See citare-scriptum's cli for all available options

Package Sidebar

Install

npm i grunt-citare-scriptum

Weekly Downloads

0

Version

0.0.1

License

none

Last publish

Collaborators

  • naganowl