{"id":23969745,"url":"https://github.com/qazsato/openapi-generate-html","last_synced_at":"2025-04-13T17:40:55.039Z","repository":{"id":259565324,"uuid":"878183355","full_name":"qazsato/openapi-generate-html","owner":"qazsato","description":"Generate standalone HTML from OpenAPI Specification. 📗","archived":false,"fork":false,"pushed_at":"2024-12-01T01:31:10.000Z","size":1898,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-01T08:47:56.097Z","etag":null,"topics":["openapi","redoc","stoplight","swagger"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qazsato.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-24T23:09:40.000Z","updated_at":"2024-12-01T07:32:12.000Z","dependencies_parsed_at":"2024-10-26T15:16:24.302Z","dependency_job_id":"51ea12ce-9fa0-4ed6-a5dc-94e260b42c76","html_url":"https://github.com/qazsato/openapi-generate-html","commit_stats":null,"previous_names":["qazsato/openapi-inline-html","qazsato/openapi-generate-html"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qazsato%2Fopenapi-generate-html","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qazsato%2Fopenapi-generate-html/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qazsato%2Fopenapi-generate-html/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qazsato%2Fopenapi-generate-html/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qazsato","download_url":"https://codeload.github.com/qazsato/openapi-generate-html/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232810805,"owners_count":18579924,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi","redoc","stoplight","swagger"],"created_at":"2025-01-07T01:53:35.738Z","updated_at":"2025-04-13T17:40:55.032Z","avatar_url":"https://github.com/qazsato.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openapi-generate-html\n\n![test](https://github.com/qazsato/openapi-generate-html/actions/workflows/test.yml/badge.svg)\n![NPM Version](https://img.shields.io/npm/v/openapi-generate-html?color=61d800)\n![NPM Downloads](https://img.shields.io/npm/dm/openapi-generate-html?color=61d800)\n![NPM License](https://img.shields.io/npm/l/openapi-generate-html?color=61d800)\n\nGenerate standalone HTML from OpenAPI Specification. \n\n## Feature\n\nOne of the key benefits of `openapi-generate-html` is its portability.\n\nBy generating a single, self-contained HTML file, all required assets (CSS, JavaScript, and OpenAPI data) are embedded directly in the document.\n\nThis makes it easy to:\n\n1. **Share** : the file as a single, standalone document without additional dependencies.\n2. **Hosting** : the file on any server or serve it locally, with no need for additional resources or configurations.\n3. **Distribute** : the file via email or other methods, knowing that it will display consistently across environments.\n\nThis portability makes `openapi-generate-html` ideal for situations where reliable, standalone documentation is required.\n\n![Using openapi-generate-html](docs/images/mermaid.png)\n\n## How to use\n\n```bash\nnpx openapi-generate-html -i openapi.json\n```\n\nUse dark theme 🌙\n\n```bash\nnpx openapi-generate-html -i openapi.json --theme=dark\n```\n\n\u003e [!NOTE]\n\u003e The dark theme is an experimental feature 🧪\n\n## CLI Options\n\n| command       | default        | description                             |\n| ------------- | -------------- | --------------------------------------- |\n| --input (-i)  |                | Input OpenAPI file path or URL          |\n| --output (-o) | \"openapi.html\" | Output HTML file name                   |\n| --ui          | \"stoplight\"    | Choose UI (stoplight / swagger / redoc) |\n| --theme       | \"light\"        | Choose Theme (light / dark)             |\n| --title       | \"OpenAPI Docs\" | Title of the HTML page                  |\n| --description |                | Description of the HTML page            |\n\n## UI Pattern\n\n|           | Light                                                                                                                                                                                | Dark 🧪                                                                                                                                                                         |\n| --------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |\n| Stoplight | ![Stoplight Light](docs/images/stoplight_light.png) \u003cbr\u003e `--ui=stoplight --theme=light` \u003cbr\u003e [sample](https://qazsato.github.io/openapi-generate-html/examples/stoplight-light.html) | ![Stoplight Dark](docs/images/stoplight_dark.png) \u003cbr\u003e `--ui=stoplight --theme=dark` \u003cbr\u003e [sample](https://qazsato.github.io/openapi-generate-html/examples/stoplight-dark.html) |\n| Swagger   | ![Swagger Light](docs/images/swagger_light.png) \u003cbr\u003e `--ui=swagger --theme=light` \u003cbr\u003e [sample](https://qazsato.github.io/openapi-generate-html/examples/swagger-light.html)         | ![Swagger Dark](docs/images/swagger_dark.png) \u003cbr\u003e `--ui=swagger --theme=dark` \u003cbr\u003e [sample](https://qazsato.github.io/openapi-generate-html/examples/swagger-dark.html)         |\n| Redoc     | ![Redoc Light](docs/images/redoc_light.png) \u003cbr\u003e `--ui=redoc --theme=light` \u003cbr\u003e [sample](https://qazsato.github.io/openapi-generate-html/examples/redoc-light.html)                 | ![Redoc Dark](docs/images/redoc_dark.png) \u003cbr\u003e `--ui=redoc --theme=dark` \u003cbr\u003e [sample](https://qazsato.github.io/openapi-generate-html/examples/redoc-dark.html)                 |\n\n## License\n\nThis project is licensed under the terms of the [MIT license](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqazsato%2Fopenapi-generate-html","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqazsato%2Fopenapi-generate-html","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqazsato%2Fopenapi-generate-html/lists"}