https://github.com/docsbydoxdox/grunt-doxdox

Generate documentation with doxdox.
https://github.com/docsbydoxdox/grunt-doxdox

Last synced: about 1 month ago
JSON representation

Generate documentation with doxdox.

• Host: GitHub
• URL: https://github.com/docsbydoxdox/grunt-doxdox
• Owner: docsbydoxdox
• License: mit
• Created: 2014-09-12T02:50:57.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-04-28T08:22:58.000Z (over 2 years ago)
• Last Synced: 2024-10-22T21:51:07.985Z (2 months ago)
• Language: JavaScript
• Homepage: http://doxdox.org/
• Size: 71.3 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grunt-doxdox

> Generate documentation with doxdox.

[![Build Status](https://travis-ci.org/neogeek/grunt-doxdox.svg?branch=master)](https://travis-ci.org/neogeek/grunt-doxdox)

[![NPM Version](http://img.shields.io/npm/v/grunt-doxdox.svg)](https://www.npmjs.org/package/grunt-doxdox)

[![Greenkeeper badge](https://badges.greenkeeper.io/neogeek/grunt-doxdox.svg)](https://greenkeeper.io/)

## Installation

```bash

$ npm install grunt grunt-doxdox --save-dev

```

## Usage

### Basic Options

```javascript

module.exports = function (grunt) {

    grunt.loadNpmTasks('grunt-doxdox');

    grunt.initConfig({

        'doxdox': {

            'markdown': {

                'inputs': ['facade.js'],

                'output': 'docs.md'

            }

        }

    });

    grunt.registerTask('default', ['doxdox']);

}

```

### Custom Configuration Options

```javascript

module.exports = function (grunt) {

    grunt.loadNpmTasks('grunt-doxdox');

    grunt.initConfig({

        'doxdox': {

            'html': {

                'inputs': ['script.js'],

                'output': 'docs/index.html',

                'config': {

                    'title': 'Sample Title',

                    'description': 'Lorem ipsum dolor sit amet, consectetur adipisicing elit',

                    'layout': 'docs/template.hbs',

                    'package': 'package.json'

                }

            }

        }

    });

    grunt.registerTask('default', ['doxdox']);

}

```