{"id":42962794,"url":"https://github.com/huma-engineering/huma-redoc","last_synced_at":"2026-01-30T23:26:28.647Z","repository":{"id":57269536,"uuid":"438733665","full_name":"huma-engineering/huma-redoc","owner":"huma-engineering","description":null,"archived":false,"fork":false,"pushed_at":"2022-01-18T10:55:08.000Z","size":7807,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-19T07:44:13.644Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/huma-engineering.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security-definitions-injection.md","support":null}},"created_at":"2021-12-15T18:30:51.000Z","updated_at":"2022-08-31T14:16:24.000Z","dependencies_parsed_at":"2022-09-02T12:31:11.374Z","dependency_job_id":null,"html_url":"https://github.com/huma-engineering/huma-redoc","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/huma-engineering/huma-redoc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huma-engineering%2Fhuma-redoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huma-engineering%2Fhuma-redoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huma-engineering%2Fhuma-redoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huma-engineering%2Fhuma-redoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/huma-engineering","download_url":"https://codeload.github.com/huma-engineering/huma-redoc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huma-engineering%2Fhuma-redoc/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28923014,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-30T22:32:35.345Z","status":"ssl_error","status_checked_at":"2026-01-30T22:32:31.927Z","response_time":66,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2026-01-30T23:26:27.864Z","updated_at":"2026-01-30T23:26:28.642Z","avatar_url":"https://github.com/huma-engineering.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# HUMA-REDOC\n\n**This is a fork of Redoc. This version includes styling changes and implementation of the Execute section for a Huma project.\n\n## About Huma Redoc\n\n[Original Redoc](https://github.com/Redocly/redoc) is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions. The current version inludes additional features:\n\n- Authentication modal\n- Execute section in the right panel\n\nBy default Redoc offers a three-panel, responsive layout:\n\n- The left panel contains a search bar and navigation menu.\n- The central panel contains the documentation.\n- The right panel contains request and response examples.\n\n![Redoc demo](https://github.com/huma-engineering/huma-redoc/blob/master/demo/redoc-demo.png)\n\n## New view\n![Redoc demo 2](https://github.com/huma-engineering/huma-redoc/blob/master/demo/redoc-demo-2.png)\n\n## Authentication modal\n![Redoc authintication](https://github.com/huma-engineering/huma-redoc/blob/master/demo/authentication.png)\n\n## Execute section\n![Redoc execute](https://github.com/huma-engineering/huma-redoc/blob/master/demo/execute.png)\n\n## Features\n- Responsive three-panel design with menu/scrolling synchronization\n- [Multiple deployment options](https://redoc.ly/docs/redoc/quickstart/intro/)\n- [Server-side rendering (SSR) ready](https://redoc.ly/docs/redoc/quickstart/cli/#redoc-cli-commands)\n- Ability to integrate your API introduction into the side menu\n- [Simple integration with `create-react-app`](https://redoc.ly/docs/redoc/quickstart/react/)\n\n  [Example repo](https://github.com/APIs-guru/create-react-app-redoc)\n- [Command-line interface to bundle your docs into a **zero-dependency** HTML file](https://redoc.ly/docs/redoc/quickstart/cli/)\n- Neat **interactive** documentation for nested objects \u003cbr\u003e\n  ![](docs/images/nested-demo.gif)\n\n## Development\n```bash\nnpm install\n```\n```bash\nnpm start\n```\n\n## Build \n```bash\nnpm run bundle\n```\n\n## Publish NPM Package\n\n### Authenticating with a personal access token\n\nTo authenticate by adding your personal access token to your `~/.npmrc` file, edit the `~/.npmrc` file for your project to include the following line, replacing GITHUB_TOKEN with your personal access token. Create a new `~/.npmrc` file if one doesn't exist.\n```\n//npm.pkg.github.com/:_authToken=GITHUB_TOKEN\n```\n### Publishing a package\n\nAdd to an `.npmrc` file to include a line specifying GitHub Packages URL and the account owner.\n```\n@huma-engineering:registry=https://npm.pkg.github.com\n```\n\nPublish the package:\n```\nnpm publish\n```\n\n## Customization options\n- High-level grouping in side-menu with the [`x-tagGroups`](https://redoc.ly/docs/api-reference-docs/specification-extensions/x-tag-groups/) specification extension\n- Branding/customizations using the [`theme` option](https://redoc.ly/docs/api-reference-docs/configuration/theming/)\n\n## Support\n- OpenAPI v3.0 support\n- Basic OpenAPI v3.1 support\n- Broad OpenAPI v2.0 feature support (yes, it supports even `discriminator`) \u003cbr\u003e\n  ![](docs/images/discriminator-demo.gif)\n- Code samples support (via vendor extension) \u003cbr\u003e\n  ![](docs/images/code-samples-demo.gif)\n\n## Version Guidance\n| Huma Redoc Release | OpenAPI Specification |\n|:--------------|:----------------------|\n| 1.0.0 | 3.1, 3.0.x, 2.0       |\n\n## Lint OpenAPI definitions\n\nRedocly's OpenAPI CLI is an open source command-line tool that you can use to lint\nyour OpenAPI definition. Linting helps you to catch errors and inconsistencies in your\nOpenAPI definition before publishing.\n\nRefer to [Lint configuration](https://redoc.ly/docs/cli/guides/lint/) in the OpenAPI documentation for more information.\n\n### Final code example\n\nTo render your OpenAPI definition using Redoc, use the following HTML code sample and\nreplace the `spec-url` attribute with the url or local file address to your definition.\n\n```html\n\u003c!DOCTYPE html\u003e\n\u003chtml\u003e\n  \u003chead\u003e\n    \u003ctitle\u003eRedoc\u003c/title\u003e\n    \u003c!-- needed for adaptive design --\u003e\n    \u003cmeta charset=\"utf-8\"/\u003e\n    \u003cmeta name=\"viewport\" content=\"width=device-width, initial-scale=1\"\u003e\n    \u003clink href=\"https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700\" rel=\"stylesheet\"\u003e\n\n    \u003c!--\n    Redoc doesn't change outer page styles\n    --\u003e\n    \u003cstyle\u003e\n      body {\n        margin: 0;\n        padding: 0;\n      }\n    \u003c/style\u003e\n  \u003c/head\u003e\n  \u003cbody\u003e\n    \u003credoc spec-url='http://petstore.swagger.io/v2/swagger.json'\u003e\u003c/redoc\u003e\n    \u003cscript src=\"https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js\"\u003e \u003c/script\u003e\n  \u003c/body\u003e\n\u003c/html\u003e\n\n```\n\nFor step-by-step instructions for how to get started using Redoc\nto render your OpenAPI definition, refer to the\n[**Redoc quickstart guide**](https://redoc.ly/docs/redoc/quickstart/intro/).\n\nSee [**IE11 Support Notes**](docs/usage-with-ie11.md) for information on\nIE support for Redoc.\n\n-----------\n\u003e The original [redoc repository](https://github.com/Redocly/redoc)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuma-engineering%2Fhuma-redoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhuma-engineering%2Fhuma-redoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuma-engineering%2Fhuma-redoc/lists"}