RAML2HTML

What RAML2HTML is

RAML2HTML turns RAML definitions into HTML documentation through a Node.js package designed for Linux and self-hosted use. You can run it from the command line to render a RAML file with its default theme, an additional theme installed from NPM, or a custom Nunjucks template. The project also gives an example of rendering to Markdown with a theme. Developers can use the package as a library, passing a filename, URL, or parsed RAML object as the render source. Rendering configuration can provide custom processing, post-process the generated HTML, manage output writing, and configure Nunjucks. RAML2HTML does not parse RAML itself; parsing-error reports are directed to raml-js-parser-2. Version 4 and later support RAML 1.0, while version 3.x supports RAML 0.8. The README describes global installation with npm. RAML2HTML is open source under the MIT license, is free, and has a free plan. The project accepts contributions through GitHub pull requests, and its organization describes a related repository as the default theme for RAML2HTML.

Who it suits

RAML2HTML suits developers who need to generate documentation from RAML definitions on Linux and can run a self-hosted Node.js package. It can also fit projects that need library-level rendering, custom templates, or additional themes.

Getting started

1. Open the RAML2HTML GitHub project.
2. Install the package globally with npm.
3. Use the command line to render a RAML file with the default theme, an installed theme, or a custom Nunjucks template.
4. For library use, provide a filename, URL, or parsed RAML object as the render source.

Verdict

Choose RAML2HTML if you need a free, self-hosted way to render RAML documentation and value command-line or library use. Look elsewhere if you need the generator itself to parse RAML, or if you need RAML support outside the version ranges described.