Skip to content
This repository has been archived by the owner on Nov 12, 2019. It is now read-only.

Latest commit

 

History

History
48 lines (33 loc) · 1.95 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.95 KB
Raw

RAML to PDF

Downloads NPM version js-standard-style

A simple RAML to PDF documentation generator, written for Node.js. It a command line version of raml2pdf and was inspired by raml2html and raml2md.

Install

npm i -g raml2pdf-cli

Usage

raml2pdf-cli input.raml output.pdf
raml2pdf-cli -e /path/to/wkhtmltopdf input.raml output.pdf
raml2pdf-cli --help
raml2pdf-cli --version

Example output

Please see https://rawgit.com/cheindl/raml2pdf-cli/master/examples/example.pdf for a live example.

RAML version support

Currently RAML 0.8 version is fully supported.

Contributing

raml2pdf-cli 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.

License

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