PHP Classes
elePHPant
Icontem

File: README.md

Recommend this page to a friend!
  Classes of Mike Stowe  >  PHP RAML to HTML  >  README.md  >  Download  
File: README.md
Role: Auxiliary data
Content type: text/markdown
Description: Auxiliary data
Class: PHP RAML to HTML
Parse RAML of an API to generate documentation
Author: By
Last change: Updating screenshot image
Date: 4 years ago
Size: 1,473 bytes
 

Contents

Class file image Download

RAML 2 HTML for PHP

RAML 2 HTML for PHP is a simple application that makes use of multiple templates to allow you to build and customize your API Docs using RAML.

Screenshot

What version of PHP does RAML 2 HTML require?

RAML 2 HTML for PHP versions 1.0 or greater require PHP 5.3+

If you are running an older version of PHP, it is highly recommend you upgrade, but if you are unable to do so, you can use RAML version 0.2 which supports PHP 5+. However, this version is extremely limited and is not being maintained or supported.

How do I set it up?

Important setup information is stored in config.php. You can read setup instructions here.

Is there a Demo?

Yes! You can find the latest stable demo and the latest development version demos here.

Does it support all RAML features?

Not yet, although version 1.0 was a complete rewrite supports base, path variables, multi-level includes, traits, and more. Other features will be added down the road!

How Can I Help?

Easy! Download and use RAML 2 HTML for PHP, tell your friends, if you find issues report them, or even better - feel free to contribute by forking and making pull requests!

License

RAML is covered under the GPL2 license. However, the included class Spyc falls under the MIT license.