raml2html documentation generator
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
example
src
.editorconfig
.gitignore
CHANGELOG.md
CONTRIBUTING.md
Dockerfile
LICENSE.md
Makefile
Readme.md
composer.json
composer.lock
index.php
raml2html

Readme.md

RAML to HTML converter with beautiful template.

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

Examples generated documentation:

Install

Via Source

$ git clone git@github.com: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