raml2html material theme

A material design theme for raml2html based on the default-theme and materialize.

Installation

$ npm install -g raml2html-material-theme

Test the example raml:

$ npm test

Usage

In javascript:

const raml2html = require('raml2html');
const materialConfig = raml2html.getConfigForTheme('raml2html-material-theme');

// source can be a filename, url or parsed RAML object
const source = 'path/to/raml/file'
raml2html.render(source, materialConfig)
  .then((html) => console.log(html))
  .catch((error) => console.error(error))

On the command line:

raml2html \
--theme 'raml2html-material-theme' \
-o 'path/to/output/file.html' \
-i 'path/to/raml/file.raml'

Contributing

raml2html-material-theme is an open source project and your contribution is very much appreciated. Fork this repository and push in your ideas.

ToDo

• Extend example raml file to test all functionalities of raml and this theme

License

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