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.
The best way to install Protagonist is by using its NPM package.
$ npm install protagonist
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.
You are welcome to contribute. Use following steps to build & test Protagonist.
Protagonist uses node-gyp build tool.
-
If needed, install node-gyp:
$ npm install -g node-gyp
-
Clone the repo + fetch the submodules:
$ git clone git://github.com/apiaryio/protagonist.git $ cd protagonist $ git submodule update --init --recursive
-
Build:
$ node-gyp configure $ node-gyp build
Inside the protagonist repository run:
$ npm install
$ npm test
Fork & Pull Request.
Make sure to follow the API Blueprint Developers discussion group. Also check the Protagonist issues page.
MIT License. See the LICENSE file.