steren / protagonist

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

Protagonist

API Blueprint Parser for Node.js

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

API Blueprint is Web API documentation language. You can find API Blueprint documentation 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);
}

Refer to Snow Crash JSON serialization for details about the AST output structure.

Hacking Protagonist

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

Build

Protagonist uses node-gyp build tool.

1. If needed, install node-gyp:

   $ npm install -g node-gyp

2. Clone the repo + fetch the submodules:

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

3. Build:

   $ node-gyp configure
   $ node-gyp build	

Test

Inside the protagonist repository run:

$ npm install
$ npm test

Contribute

Fork & Pull Request.

Make sure to follow the API Blueprint Developers discussion group. Also check the Protagonist issues page.

License

MIT License. See the LICENSE file.