| 1 | <img alt="MrinDoc logo" src="https://github.com/mrin9/RapiPdf/blob/master/logo.png" width="60px" />
|
| 2 |
|
| 3 |
|
| 4 | <p align="center">
|
| 5 | <img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square"/>
|
| 6 | <img src="https://img.shields.io/github/size/mrin9/rapipdf/dist/rapipdf-min.js.svg?colorB=blue&label=minified&style=flat-square">
|
| 7 | <img src="https://img.shields.io/github/size/mrin9/rapipdf/dist/rapipdf-min.js.gz.svg?colorB=blue&label=zip&style=flat-square">
|
| 8 | </p>
|
| 9 |
|
| 10 | # RapiPDF
|
| 11 | Custom Eelement for Open-API to PDF generation
|
| 12 |
|
| 13 | ## Features
|
| 14 | - Supports Swagger 2.0 and OpenAPI 3.0
|
| 15 | - Generate PDF using Web-Component
|
| 16 | - Works with any framework or with no framework
|
| 17 | - Plenty of customizing options, including selection of brand colors
|
| 18 | - Supported on Chrome, FireFox and Safari. (Not yet tested on Edge)
|
| 19 |
|
| 20 | ## Documentation
|
| 21 | [Check out the usage and examples](https://mrin9.github.io/RapiPdf/)
|
| 22 |
|
| 23 | ## Build Process
|
| 24 | We recommend `yarn` over `npm` as we use yarn [resolutions](https://yarnpkg.com/lang/en/docs/selective-version-resolutions/) to keep the bundle size smaller. As of this writing this feature is not supported in npm natively
|
| 25 | ```bash
|
| 26 | # Clone / Download the project then
|
| 27 | yarn install
|
| 28 |
|
| 29 | # build will generate rapidoc-min.js, this is the only file you will need.
|
| 30 | # use it in the script tag of your html <script type="text/javascript" src="rapidoc-min.js"></script></body>
|
| 31 | yarn build
|
| 32 |
|
| 33 | # for developement use yarn serve (this will start an webserver at port 8080, then navigate to localhost:8080)
|
| 34 | yarn serve
|
| 35 | ``` |
| \ | No newline at end of file |