ajbrown / gradle-raml-plugin

A Gradle plugin which validates your RAML specification, and turns it into HTML documentation

This project contains the complete source code for my personal website, which is generated using Jekyll and hosted with Github Pages.

The information I provide here is my own creative work, and any opinions expressed are those of my own. Please consider any examples or solutions as advice only, and make sure things work correctly in your environment. I won't be liable if you break something, introduce a security hole, or run up a usage bill.

Running Jekyll

bundle exec jekyll serve

gradle-raml-plugin's Issues

Create new templates for HTML output

This plugin uses Handlebars templates processed by Handlebars.java to generate HTML from RAML. The templates currently being used were lifted from raml2html, and adapted to match the model generated by the java-raml-processor.

The raml2html templates are only intended to be a proof of concept. We need to come up with our own design that works well with the java RAML model. Lets make it look clean, and be interactive where appropriate (example outputs, schemas, etc).

Support custom templates

The current version only supports loading templates supplied by the plugin itself. Users will want to be able to customize the HTML output that's generated.