RAML to HTML converter with beautiful template.

More documentation: http://raml2html.leanlabs.io/

Examples generated documentation:

• Github api http://raml2html.leanlabs.io/github

Install

Via Source

$ git clone [email protected]:raml-leanlabsio/raml2html.git && cd raml2html && composer install --no-dev

Via binary

Download latest stable release raml2html.phar release

Usage

As binary

./raml2html generate -i example/raml/basic/api.raml -o index.html

As docker image

Assuming that command executed in project directory containing raml file

docker run  \
   -v `pwd`:/data \
   leanlabs/raml-doc-builder \
   generate --input=input.raml --output=doc.html

OPTIONS

• -i, --input input file base raml file with includes. (required)
• -o, --output output file "index.html" (required)

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.

Dependencies

• raml2html base in raml parser

• official raml specification