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:

``shell
npm install grunt-protagonist --save-dev
`

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

`js
grunt.loadNpmTasks('grunt-protagonist');
`

The "protagonist" task

$3


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

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

$3

`js
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)_