grunt-raml2html

Compile RAML to HTML

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-raml2html --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-raml2html');

The "raml2html" task

Overview

In your project's Gruntfile, add a section named raml2html to the data object passed into grunt.initConfig().

grunt.initConfig({
  raml2html: {
    all: {
      options: {
        // Task-specific options go here.
      },
      default: {
        // Target-specific file lists and/or options go here.
      }
    }
  },
});

Options

options.separator

Type: String Default value: ', '

A string value that is used to do something with whatever.

options.punctuation

Type: String Default value: '.'

A string value that is used to do something else with whatever else.

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  raml2html: {
    all: {
      files: {
        'dest/api.html': ['api.raml'],
      }
    }
  },
});

Custom Options

In this example, custom options are used to do something else with whatever else. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result in this case would be Testing: 1 2 3 !!!

grunt.initConfig({
  raml2html: {
    all: {
      options: {
        separator: ': ',
        punctuation: ' !!!'
      },
      files: {
        'dest/api.html': ['src/github.raml'],
      }
    }
  },
});

Custom Template

Custom templates can be loaded using the following. Both mainTemplate and templatesPath are required in this case. Other templates, such as resource.nunjucks and item.nunjucks are now seen as part of the main template. Therefore they cannot be set individually.

grunt.initConfig({
  raml2html: {
    all: {
      options: {
        mainTemplate: 'template.nunjucks',
        templatesPath: './my/custom/path'
      },
      files: {
        'dest/api.html': ['src/github.raml'],
      }
    }
  },
});

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.