grunt-raml2boot v0.1.2

grunt-raml2boot

Grunt task for RAML to Bootstrap.

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-raml2boot --save-dev

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

grunt.loadNpmTasks('grunt-raml2boot');

Usage

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

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

Options

options.standalone

Type: boolean Default value: true

If true, a standalone HTML page with a navbar and title will be generated. If false, only a partial HTML fragment will be generated, to be included in a complete page elsewhere.

This options has no effect if the layout option is specified.

options.layout

Type: string

The path to a custom layout file to use.

Examples

In this example, the raml2boot:apidoc task will parse the RAML file at doc/api.raml and save the resulting HTML to dest/api.html.

grunt.initConfig({
  raml2boot: {
    options: {
      standalone: true
    },
    apidoc: {
      files: {
        'dest/api.html': 'doc/api.raml'
      }
    }
  },
});

Contributing

• Fork
• Create a topic branch - git checkout -b feature
• Push to your branch - git push origin feature
• Create a pull request from your branch

Please add a changelog entry with your name for new features and bug fixes.

License

grunt-raml2boot is licensed under the MIT License. See LICENSE.txt for the full text.