Ramlstyle

Validates the a RAML file, runs lint rules against it, and produces HTML documentation. RAMLStyle currently only works with RAML version 0.8. RAML 1.0 support should be coming soon.

Install this gem from rubygems:

gem install ramlstyle

If you are using your system ruby, you may need to use sudo:

sudo gem install ramlstyle

Usage: ramlstyle [options] file1 file2 ...

--no-document    | Do not produce HTML documentation
--no-lint        | Do not run linter rules

-o, --output-dir DIR | Write HTML documentation to DIR --version | print the version -h, --help | Display this screen

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/mmorga/ramlstyle.

1. Templates are derived from templates from RAML2HTML
2. RAML is parsed with raml_ruby