protagonist

Protagonist

API Blueprint Parser for Node.js

Protagonist is a Node.js wrapper for the Snow Crash library.

API Blueprint is REST API documentation language. Full API Blueprint documentation can be found on the API Blueprint site.

Install

The best way to install Protagonist is by using its NPM package.

$ npm install protagonist

Getting started

var protagonist = require('protagonist');
protagonist.parse('# My API', function(error, result) {
	if (error) {
   		console.log(error);
	    return;
  	}
  
	console.log(result.ast);
}

Hacking

You are welcome to contribute. Use following steps to build & test Protagonist.

Build

Protagonist uses node-gyp build tool.

1. Clone the repo + fetch the submodules:

    $ git clone git://github.com/apiaryio/protagonist.git
    $ cd protagonist
    $ git submodule update --init --recursive
   

2. If needed, install node-gyp:

    $ cd ..
    $ npm install -g node-gyp
   

3. Build:

    $ node-gyp configure
    $ node-gyp build
   

Test

Inside protagonist repository run:

$ npm install
$ npm test

License

MIT License. See LICENSE file.