RAML to HTML documentation generator
A simple RAML to HTML documentation generator, written for Node.js. Check raml2md for a RAML to Markdown generator.
npm i -g raml2html
raml2html --helpraml2html example.raml > example.htmlraml2html -i example.raml -o example.htmlraml2html -s -i example.raml -o example.htmlraml2html -t custom-template.handlebars -r custom-resource.handlebars -m custom-item.handlebars -i example.raml -o example.html
HTTPS If the generated file will be hosted on a https domain, you will need to run raml2html with the
-soption so the external dependancies will also use https links.
var raml2html = require('raml2html');// Using the default templates:// source can either be a filename, url, file contents (string) or parsed RAML objectvar config = raml2html.getDefaultConfig(https); // https is a boolean, true means https links will be used instead of httpraml2html.render(source, config, onSuccess, onError);// Using your own templates:// - config should be an object with at least an `template` property (a string containing the main template)// - config can also include `helpers` and `partials`// - config can also include a boolean `https` (default is false)// - config can also include a function `processOutput` which will receive the raw rendered HTML, onSuccess and onError callbacks// - the config object will be accessible from your handlebars templatesraml2html.render(source, config, onSuccess, onError);
example/script.js for an example of using raml2html as a library.
There's a third party Grunt plugin at https://www.npmjs.org/package/grunt-raml2html.
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.
raml2html is an open source project and your contribution is very much appreciated.
- Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
- 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.
- Add an example of the new feature to example.raml (if applicable)
- Send a pull request (with the develop branch as the target).
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.
This project is still a work in progress, but the output is very usable already (and is in fact used by multiple companies including Google). Still left to do, in no particular order:
- Template options (for example to turn off side bar navigation)
- Finish HTML output, currently there's still some stuff missing (like securedBy)
raml2html is available under the MIT license. See the LICENSE file for more info.