RAML to HTML

A simple RAML to HTML documentation generator, written for Node.js. Check raml2md for a RAML to Markdown generator.

Install

npm i -g raml2html

Usage

As a command line script

raml2html --help
raml2html example.raml > example.html
raml2html -t examples/custom-template-test/template.nunjucks -i example.raml -o example.html

As a library

Using the default templates or your own Nunjucks templates

const raml2html = require('raml2html');
const configWithDefaultTemplates = raml2html.getDefaultConfig();
const configWithCustomTemplates = raml2html.getDefaultConfig('my-custom-template.nunjucks', __dirname);

// source can either be a filename, url, or parsed RAML object
raml2html.render(source, configWithDefaultTemplates).then(function(result) {
  // Save the result to a file or do something else with the result
}, function(error) {
  // Output error
});

Using your own processing function, for when you want to use another template language

/**
 * config should be an object with at least an `processRamlObj` property which is a function that receives the raw RAML 
 * object and must return a promise with the result. You can do whatever you want in this function.
 *
 * You can also supply a postProcessHtml function that can for example minify the generated HTML.
 */
raml2html.render(source, config).then(function(result) {
  // Save the result to a file or do something else with the result
}, function(error) {
  // Output error
});

If you only want to configure the default Nunjucks environment you don't have to override the entire processRamlObj function. Just get the default config (const config = raml2html.getDefaultConfig();) and add a setupNunjucks function to it that takes env as its only parameter.

See also example/script.js for an example of using raml2html as a library.

Please note that if you want to use a different template language, you're probably better off directly using raml2obj.

Gulp

You can use the latest raml2html directly from Gulp, or use the third party gulp-raml2html plugin (which uses an outdated version of raml2html).

Grunt

There's a third party Grunt plugin at https://www.npmjs.org/package/grunt-raml2html.

Example output

Please see https://rawgit.com/raml2html/raml2html/master/examples/example.html for a live example.

RAML version support

raml2html 4 and higher only support RAML 1.0 files. Please stick with raml2html 3.x for RAML 0.8 support.

Before you report a bug

If you get parsing errors, please do not report them to raml2html: it doesn't do the actual RAML parsing. Review the error and fix your RAML file, or open a new issue at raml-js-parser.

Contributing

raml2html is an open source project and your contribution is very much appreciated.

1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
2. Fork the repository on Github and make your changes on the develop branch (or branch off of it).
   Please retain the code style that is used in the project and npm run lint before committing.
3. Add an example of the new feature to example.raml (if applicable)
4. Send a pull request (with the develop branch as the target).

If your pull request is merged feel free to ask for push access. We want to get more maintainers! If you do have push access, please still work on feature branches and create pull requests, which then get reviewed. You can also review other people's pull requests and be involved in that way.

A big thank you goes out to everyone who helped with the project, the contributors and everyone who took the time to report issues and give feedback.

Changelog

See changelog.md

License

raml2html is available under the MIT license. See the LICENSE file for more info.