Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.26 KB

README.md

File metadata and controls

48 lines (35 loc) · 1.26 KB
Raw

grunt-protagonist

API Blueprint parser

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

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

grunt.loadNpmTasks('grunt-protagonist');

The "protagonist" task

Overview

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

grunt.initConfig({
  protagonist: {
    src: 'api.apib',
    apis: ['api1.apib', 'api2.apib']
  },
});

Usage Examples

grunt.initConfig({
  protagonist: {
    src: 'api/api.apib',
  },
});

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.

Release History

(Nothing yet)