Skip to content

A simple RAML to HTML documentation generator, wrapped for Gulp.

License

Notifications You must be signed in to change notification settings

repocho/gulp-raml2html

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gulp-raml2html Build Status NPM version Dependency Status

A simple RAML to HTML documentation generator.

If you have any difficulties with the output of this plugin, please use the raml2html tracker.

Install via npm:

npm install gulp-raml2html --save-dev

Note that this plugin wraps raml2html.

Example

var gulp = require('gulp');
var raml2html = require('gulp-raml2html');

gulp.task('apidoc', function() {
  return gulp.src('api.raml')
    .pipe(raml2html())
    .pipe(gulp.dest('build'));
});

API

supportJsonInput

Type: boolean Default value: false

When set to true it also takes JSON files as input (generated by the RAML parser).

License

The code for gulp-raml2html is licensed under the MIT license. See license.txt file for more info.

About

A simple RAML to HTML documentation generator, wrapped for Gulp.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%