A simple RAML to HTML documentation generator.
gulp-raml2html is back in the game. But you can still help us by submitting PRs on
develop branch. Thanks in advance!`
A simple gulp plugin to automate the process of generating HTML documentation based on a RAML API.
If you have any difficulties with the output of this plugin, please use the raml2html tracker.
Note: This plugin wraps raml2html.
npm install gulp-raml2html --save-dev
Gulp is a build life-cycle tool. You can configure several tasks to be ran when entering
gulp [taskname] in your console ('default' task is invoked if not specified). It can also be invoked by Continuous Integration tools.
To be able to use it, your application must have a
gulpfile.js with the possible tasks configured.
gulpfile.js will start with:
var gulp = ;var raml2html = ;
// your existing tasksgulp;// more tasks
gulp apidoc will grab
api.raml and generate a
build folder with the generated HTML on it.
Included in this repository. Click here to go to the "example" folder
When set to
true it also takes JSON files as input (generated by the RAML parser).
When set to
raml2html generator will output links to the all assets over
The code for gulp-raml2html is licensed under the MIT license. See
license.txt file for more info.