raml-leanlabsio/raml2html

There is no license information available for the latest version (0.0.6) of this package.

PHP RAML to HTML documentation generator

Maintainers

Details

github.com/raml-leanlabsio/raml2html

Homepage

Source

Issues

Documentation

Installs: 821

Dependents: 0

Suggesters: 0

Security: 0

Stars: 32

Watchers: 8

Forks: 9

Open Issues: 16

Language:HTML

0.0.6 2016-01-30 14:50 UTC

Requires

Unknown License af058343eea4454ceac9b6a17983c75d17cac08c

  • Anton Popov <cnam812.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-04-13 15:23:24 UTC

README

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