{"_id":"@aleung/redoc","_rev":"2-4dd6973637d13eb6445f15560ae50f17","name":"@aleung/redoc","dist-tags":{"latest":"2.1.4"},"versions":{"2.0.0":{"name":"@aleung/redoc","version":"2.0.0","description":"ReDoc (maintainence fork)","repository":{"type":"git","url":"git://github.com/aleung/redoc"},"engines":{"node":">=6.9","npm":">=3.0.0"},"author":{"name":"Roman Hotsiy","email":"gotsijroman@gmail.com"},"license":"MIT","keywords":["OpenAPI","OpenAPI Specification","Swagger","JSON-Schema","API","REST","documentation","React.js"],"main":"bundles/redoc.lib.js","types":"typings/index.d.ts","scripts":{"start":"webpack-dev-server --mode=development --env.playground --hot --config demo/webpack.config.ts","start:prod":"webpack-dev-server --env.playground --mode=production --config demo/webpack.config.ts","start:benchmark":"webpack-dev-server --mode=production --env.bench --config demo/webpack.config.ts","test":"npm run lint && npm run unit && npm run license-check","unit":"jest --coverage","e2e":"cypress run","e2e-ci":"cypress run --record","bundlesize":"bundlesize","cy:open":"cypress open","bundle:clean":"rimraf bundles","bundle:standalone":"webpack --env.standalone --mode=production","bundle:lib":"webpack --mode=production && npm run declarations","bundle":"npm run bundle:clean && npm run bundle:lib && npm run bundle:standalone","declarations":"tsc --emitDeclarationOnly -p tsconfig.lib.json && cp -R src/types typings/","stats":"webpack --env.standalone --json --profile --mode=production > stats.json","prettier":"prettier --write \"cli/index.ts\" \"src/**/*.{ts,tsx}\"","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 1","lint":"eslint 'src/**/*.{js,ts,tsx}'","benchmark":"node ./benchmark/benchmark.js","start:demo":"webpack-dev-server --hot --config demo/webpack.config.ts --mode=development","compile:cli":"tsc custom.d.ts cli/index.ts --target es6 --module commonjs --types yargs","build:demo":"webpack --mode=production --config demo/webpack.config.ts","deploy:demo":"aws s3 sync demo/dist s3://production-redoc-demo --acl=public-read","license-check":"license-checker --production --onlyAllow 'MIT;ISC;Apache-2.0;BSD;BSD-2-Clause;BSD-3-Clause' --summary","docker:build":"docker build -f config/docker/Dockerfile -t redoc ."},"devDependencies":{"@babel/core":"^7.10.5","@babel/plugin-syntax-decorators":"^7.10.4","@babel/plugin-syntax-dynamic-import":"^7.8.3","@babel/plugin-syntax-jsx":"^7.10.4","@babel/plugin-syntax-typescript":"^7.10.4","@cypress/webpack-preprocessor":"^5.4.2","@hot-loader/react-dom":"^16.12.0","@types/chai":"^4.2.12","@types/dompurify":"^2.0.2","@types/enzyme":"^3.10.5","@types/enzyme-to-json":"^1.5.3","@types/jest":"^26.0.7","@types/json-pointer":"^1.0.30","@types/lodash":"^4.14.158","@types/lunr":"^2.3.3","@types/mark.js":"^8.11.5","@types/marked":"^1.1.0","@types/prismjs":"^1.16.1","@types/prop-types":"^15.7.3","@types/react":"^16.9.43","@types/react-dom":"^16.9.8","@types/react-tabs":"^2.3.2","@types/styled-components":"^5.1.1","@types/tapable":"^1.0.6","@types/webpack":"^4.41.21","@types/webpack-env":"^1.15.2","@types/yargs":"^15.0.5","@typescript-eslint/eslint-plugin":"^3.7.0","@typescript-eslint/parser":"^3.7.0","babel-loader":"^8.1.0","babel-plugin-styled-components":"^1.10.7","beautify-benchmark":"^0.2.4","bundlesize":"^0.18.0","conventional-changelog-cli":"^2.0.34","copy-webpack-plugin":"^6.0.3","core-js":"^3.6.5","coveralls":"^3.1.0","css-loader":"^3.6.0","cypress":"^4.11.0","enzyme":"^3.11.0","enzyme-adapter-react-16":"^1.15.2","enzyme-to-json":"^3.5.0","eslint":"^7.5.0","eslint-plugin-import":"^2.22.0","eslint-plugin-react":"^7.20.3","fork-ts-checker-webpack-plugin":"^5.0.11","html-webpack-plugin":"^4.3.0","jest":"^26.1.0","license-checker":"^25.0.1","lodash":"^4.17.19","mobx":"^6.0.4","prettier":"^2.0.5","raf":"^3.4.1","react":"^16.13.1","react-dom":"^16.13.1","react-hot-loader":"^4.12.21","rimraf":"^3.0.2","shelljs":"^0.8.4","source-map-loader":"^1.0.1","style-loader":"^1.2.1","styled-components":"^5.1.1","ts-jest":"^26.1.3","ts-loader":"^8.0.1","ts-node":"^8.10.2","typescript":"^3.9.7","unfetch":"^4.1.0","url-polyfill":"^1.1.10","webpack":"^4.44.0","webpack-cli":"^3.3.12","webpack-dev-server":"^3.11.0","webpack-node-externals":"^2.5.0","workerize-loader":"^1.3.0","yaml-js":"^0.2.3"},"peerDependencies":{"core-js":"^3.1.4","mobx":"^6.0.4","react":"^16.8.4","react-dom":"^16.8.4","styled-components":"^4.1.1 || ^5.1.1"},"dependencies":{"@redocly/react-dropdown-aria":"^2.0.11","@types/node":"^13.11.1","classnames":"^2.2.6","decko":"^1.2.0","dompurify":"^2.0.12","eventemitter3":"^4.0.4","json-pointer":"^0.6.0","json-schema-ref-parser":"^6.1.0","lunr":"2.3.8","mark.js":"^8.11.1","marked":"^0.7.0","memoize-one":"~5.1.1","mobx-react":"^7.0.5","openapi-sampler":"^1.0.0-beta.18","perfect-scrollbar":"^1.4.0","polished":"^3.6.5","prismjs":"^1.22.0","prop-types":"^15.7.2","react-tabs":"^3.1.1","slugify":"^1.4.4","stickyfill":"^1.1.1","swagger2openapi":"^6.2.1","tslib":"^2.0.0","url-template":"^2.0.8"},"bundlesize":[{"path":"./bundles/redoc.standalone.js","maxSize":"300 kB"}],"jest":{"setupFilesAfterEnv":["<rootDir>/src/setupTests.ts"],"preset":"ts-jest","collectCoverageFrom":["src/**/*.{ts,tsx}"],"coverageReporters":["json","lcov","text-summary"],"coveragePathIgnorePatterns":["\\.d\\.ts$","/benchmark/","/node_modules/"],"modulePathIgnorePatterns":["/benchmark/"],"moduleNameMapper":{"\\.(css|less)$":"<rootDir>/src/empty.js"}},"prettier":{"singleQuote":true,"trailingComma":"all","printWidth":100,"parser":"typescript"},"licenseText":"The MIT License (MIT)\n\nCopyright (c) 2015-present, Rebilly, Inc. \n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n","_id":"@aleung/redoc@2.0.0","dist":{"shasum":"761c747da5727ef6cffabc2ab5c3570946ba350e","integrity":"sha512-eG1opfLSw6299z63gvF0QXH8haDbgbhiSMp0QkNme61mWAkRsxuW/WC+xoVSIrv1jxqvXG4NJgJyVoL9lGbTgA==","tarball":"https://registry.npmjs.org/@aleung/redoc/-/redoc-2.0.0.tgz","fileCount":197,"unpackedSize":6868161,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf/pbbCRA9TVsSAnZWagAAt+4P/RHKNl23ItTE32LqlMex\nl/VGNx10/KGyZwm7+xK1yI+YFDftvFC0Z6gFw6/4j9IZlt/ckYVffmgh0y10\nriAl0DvBLNNg9FbXDU/1YWT544BfhvIL1APcQih85kw3/08NUkauZyb6FC2v\nhnIFdpuI6Y280zJzLsYr9Fu5pgNAuQtNd/ZPt2y0MJQxqHLUDLZrDjO9ykxI\nEMNB3YhaF8d+8G5CuNp2jvzb7kjaBOSnsficGHHIYDmNzvnx/88ItYCWrz2P\nCTN5DoeSZN1t2qfbMJD+fmBoLaFb1YZyM5/CTmZT6M7JT8Xvo0U1er5hhkaY\nBCwrMgNBVIiiX9w/tsuvKzazwnZye9VuJnYQa3Znx1HI1crWTXAyE8/iuhpl\nPakcbCRXCfpdtM0YkIFChql2yrc5XUZY7QXVO3YfLmJZ5XNkLwAXGIebOIrh\nSgM3+QeWQXRlZ7gEB7Q/kjJqHu8s+WQgOS7C5W8bX+b30FNtBIrQwuZMq3B2\nWmoOyYIAF1aIneMJWADEKGaS9HWKypMWBlMMPuSeOgZg8zJmkwvtXejON3t7\n59Gj8XeQXXN7Aq3coY9Bm0Uc9AuD0iF/nedshJhXQF69J7hzhej9qDWcqkg/\nASw7jiKtyROVIjgnTpuwQGkcdEw35R5J88eKdTVHR7rPXNZLH4c3WJTG0+u4\nXy1p\r\n=ZDuy\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCxvgaNMYh72pKxIenXIEs4NR9FRSDDXMxlo6ESctDf1AIhAJohYbdD+VYwtzK7L/n9rNXQkTzgMe2mmzAcSinGl48g"}]},"_npmUser":{"name":"aleung","email":"leoliang@gmail.com"},"directories":{},"maintainers":[{"name":"aleung","email":"leoliang@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/redoc_2.0.0_1610520282436_0.025545830026132865"},"_hasShrinkwrap":false},"2.1.4":{"name":"@aleung/redoc","version":"2.1.4","description":"ReDoc (maintainence fork)","repository":{"type":"git","url":"git://github.com/aleung/redoc.git"},"browserslist":["defaults"],"engines":{"node":">=6.9","npm":">=3.0.0"},"author":{"name":"Roman Hotsiy","email":"gotsijroman@gmail.com"},"license":"MIT","keywords":["OpenAPI","OpenAPI Specification","Swagger","JSON-Schema","API","REST","documentation","React.js"],"main":"bundles/redoc.lib.js","browser":"bundles/redoc.browser.lib.js","types":"typings/index.d.ts","scripts":{"start":"webpack serve --mode=development --env playground --hot --config demo/webpack.config.ts","start:prod":"webpack serve --env playground --mode=production --config demo/webpack.config.ts","start:benchmark":"webpack serve --mode=production --env.bench --config demo/webpack.config.ts","test":"npm run unit && npm run license-check","unit":"jest --coverage","test:update-snapshot":"jest --updateSnapshot","e2e":"cypress run","e2e-ci":"cypress run --record","bundlesize":"size-limit","ts-check":"tsc --noEmit --skipLibCheck","cy:open":"cypress open","bundle:clean":"rimraf bundles","bundle:standalone":"webpack --env production --env standalone --mode=production","bundle:lib":"webpack --mode=production && npm run declarations","bundle:browser":"webpack --env production --env browser --mode=production","bundle":"npm run bundle:clean && npm run bundle:lib && npm run bundle:browser && npm run bundle:standalone","declarations":"tsc --emitDeclarationOnly -p tsconfig.lib.json && cp -R src/types typings/","stats":"webpack --env production --env standalone --json --profile --mode=production > stats.json","prettier":"prettier --write \"src/**/*.{ts,tsx}\"","changelog":"conventional-changelog -p angular -i CHANGELOG.md -s -r 1","lint":"eslint --fix 'src/**/*.{js,ts,tsx}' --cache","benchmark":"node ./benchmark/benchmark.js","start:demo":"webpack serve --hot --config demo/webpack.config.ts --mode=development","build:demo":"webpack --mode=production --config demo/webpack.config.ts","publish-cdn":"scripts/publish-cdn.sh","deploy:demo":"aws s3 sync demo/dist s3://production-redoc-demo --acl=public-read","license-check":"license-checker --production --onlyAllow 'MIT;ISC;Apache-2.0;BSD;BSD-2-Clause;BSD-3-Clause;CC-BY-4.0;Python-2.0' --summary","docker:build":"docker build -f config/docker/Dockerfile -t redoc .","prepare":"husky install","pre-commit":"pretty-quick --staged && npm run lint"},"devDependencies":{"@cypress/webpack-preprocessor":"^5.17.1","@hot-loader/react-dom":"^17.0.2","@size-limit/preset-app":"^8.2.6","@types/chai":"^4.2.18","@types/dompurify":"^2.2.2","@types/enzyme":"^3.10.5","@types/enzyme-to-json":"^1.5.3","@types/jest":"^26.0.23","@types/json-pointer":"^1.0.30","@types/lunr":"^2.3.3","@types/mark.js":"^8.11.5","@types/marked":"^4.0.3","@types/node":"^15.6.1","@types/prismjs":"^1.16.5","@types/prop-types":"^15.7.3","@types/react":"^17.0.8","@types/react-dom":"^17.0.5","@types/styled-components":"^5.1.1","@types/tapable":"^2.2.2","@types/webpack":"^5.28.0","@types/webpack-env":"^1.18.0","@types/yargs":"^17.0.0","@typescript-eslint/eslint-plugin":"^4.26.0","@typescript-eslint/parser":"^4.26.0","@wojtekmaj/enzyme-adapter-react-17":"^0.6.1","beautify-benchmark":"^0.2.4","conventional-changelog-cli":"^3.0.0","copy-webpack-plugin":"^9.0.0","core-js":"^3.13.1","coveralls":"^3.1.1","css-loader":"^5.2.6","cypress":"^13.1.0","enzyme":"^3.11.0","enzyme-to-json":"^3.6.2","esbuild-loader":"^3.0.1","eslint":"^7.27.0","eslint-plugin-import":"^2.23.4","eslint-plugin-react":"^7.25.1","eslint-plugin-react-hooks":"^4.2.0","fork-ts-checker-webpack-plugin":"^6.2.10","html-webpack-plugin":"^5.3.1","husky":"^7.0.0","jest":"^27.0.3","js-yaml":"^4.1.0","license-checker":"^25.0.1","lodash.noop":"^3.0.1","mobx":"^6.3.2","outdent":"^0.8.0","prettier":"^2.3.2","pretty-quick":"^3.0.0","raf":"^3.4.1","react":"^17.0.2","react-dom":"^17.0.2","react-hot-loader":"^4.13.0","rimraf":"^3.0.2","shelljs":"^0.8.4","size-limit":"^8.2.6","style-loader":"^3.3.1","styled-components":"^5.3.0","ts-jest":"^27.0.2","ts-node":"^10.9.1","tslib":"^2.4.0","typescript":"^4.8.4","unfetch":"^4.2.0","url":"^0.11.1","webpack":"^5.88.2","webpack-cli":"^5.1.4","webpack-dev-server":"^4.15.1","webpack-node-externals":"^3.0.0","workerize-loader":"github:redocly/workerize-loader#webpack-5-dist"},"peerDependencies":{"core-js":"^3.1.4","mobx":"^6.0.4","react":"^16.8.4 || ^17.0.0 || ^18.0.0","react-dom":"^16.8.4 || ^17.0.0 || ^18.0.0","styled-components":"^4.1.1 || ^5.1.1 || ^6.0.5"},"dependencies":{"@redocly/openapi-core":"^1.0.0-rc.2","classnames":"^2.3.1","decko":"^1.2.0","dompurify":"^2.2.8","eventemitter3":"^4.0.7","json-pointer":"^0.6.2","lunr":"^2.3.9","mark.js":"^8.11.1","marked":"^4.0.15","mobx-react":"^7.2.0","openapi-sampler":"^1.3.1","path-browserify":"^1.0.1","perfect-scrollbar":"^1.5.5","polished":"^4.1.3","prismjs":"^1.27.0","prop-types":"^15.7.2","react-tabs":"^4.3.0","slugify":"~1.4.7","stickyfill":"^1.1.1","swagger2openapi":"^7.0.6","url-template":"^2.0.8"},"size-limit":[{"path":"./bundles/redoc.standalone.js","limit":"350 kB"},{"path":"./bundles/redoc.lib.js","limit":"100 kB"},{"path":"./bundles/redoc.browser.lib.js","limit":"100 kB"}],"jest":{"testEnvironment":"jsdom","setupFilesAfterEnv":["<rootDir>/src/setupTests.ts"],"preset":"ts-jest","collectCoverageFrom":["src/**/*.{ts,tsx}"],"coverageReporters":["json","lcov","text-summary"],"coveragePathIgnorePatterns":["\\.d\\.ts$","/benchmark/","/node_modules/","src/services/__tests__/models/helpers.ts"],"modulePathIgnorePatterns":["/benchmark/","src/services/__tests__/models/helpers.ts"],"snapshotSerializers":["enzyme-to-json/serializer"],"moduleNameMapper":{"\\.(css|less)$":"<rootDir>/src/empty.js"}},"prettier":{"singleQuote":true,"trailingComma":"all","printWidth":100,"arrowParens":"avoid"},"_id":"@aleung/redoc@2.1.4","gitHead":"6338fdc51ca9b5cd2f7c613475a43f6cdc08cebe","bugs":{"url":"https://github.com/aleung/redoc/issues"},"homepage":"https://github.com/aleung/redoc#readme","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-6PAHspp/qsQ8aXkKs2JmpZ7WTtnjVQFs1az6oKEOw1rFNjaYzwNcvt1O/BkhRKfBilg/93ROMsyeeb/Rh2JI+A==","shasum":"6a4f44a292ef12efe90dbbdd5d575e32d610801b","tarball":"https://registry.npmjs.org/@aleung/redoc/-/redoc-2.1.4.tgz","fileCount":174,"unpackedSize":6745493,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIADYBux73d5Z93a6xD3hyReklvkiSgFhaAh8psHr0BTYAiBkWmAcKvbJYeM1dgeeWYkO+RGg6bK4ps8hffAg0XLxiA=="}]},"_npmUser":{"name":"aleung","email":"leoliang@gmail.com"},"directories":{},"maintainers":[{"name":"aleung","email":"leoliang@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/redoc_2.1.4_1705997826167_0.5145474430572086"},"_hasShrinkwrap":false}},"time":{"created":"2021-01-13T06:44:42.380Z","2.0.0":"2021-01-13T06:44:42.681Z","modified":"2024-01-23T08:17:06.562Z","2.1.4":"2024-01-23T08:17:06.396Z"},"maintainers":[{"name":"aleung","email":"leoliang@gmail.com"}],"description":"ReDoc (maintainence fork)","keywords":["OpenAPI","OpenAPI Specification","Swagger","JSON-Schema","API","REST","documentation","React.js"],"repository":{"type":"git","url":"git://github.com/aleung/redoc.git"},"author":{"name":"Roman Hotsiy","email":"gotsijroman@gmail.com"},"license":"MIT","readme":"<div align=\"center\">\n  <img alt=\"Redoc logo\" src=\"https://raw.githubusercontent.com/Redocly/redoc/main//docs/images/redoc.png\" width=\"400px\" />\n\n  # Generate beautiful API documentation from OpenAPI\n\n  [![npm](http://img.shields.io/npm/v/redoc.svg)](https://www.npmjs.com/package/redoc) [![License](https://img.shields.io/npm/l/redoc.svg)](https://github.com/Redocly/redoc/blob/main/LICENSE)\n\n  [![bundle size](http://img.badgesize.io/https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js?compression=gzip&max=300000)](https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js) [![npm](https://img.shields.io/npm/dm/redoc.svg)](https://www.npmjs.com/package/redoc) [![](https://data.jsdelivr.com/v1/package/npm/redoc/badge)](https://www.jsdelivr.com/package/npm/redoc)\n</div>\n\n\n> **Note:** This is a maintainence fork of ReDoc, including some PRs which are not merged in upstream.\n> Please read CHANGLOG.md for the difference between upstream.\n> Publish at https://www.npmjs.com/package/@aleung/redoc and https://www.npmjs.com/package/@aleung/redoc-cli\n\n## About Redoc\n\nRedoc is an open source tool for generating documentation from OpenAPI (formerly Swagger) definitions.\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://raw.githubusercontent.com/Redocly/redoc/main/demo/redoc-demo.png)\n\n## Live demo\n\nIf you want to see how Redoc renders your OpenAPI definition,\nyou can try it out online at https://redocly.github.io/redoc/.\n\nA version of the Swagger Petstore API is displayed by default.\nTo test it with your own OpenAPI definition,\nenter the URL for your definition and select **TRY IT**.\n\n## Redoc features\n\n- Responsive three-panel design with menu/scrolling synchronization\n- Support for OpenAPI 3.1, OpenAPI 3.0, and Swagger 2.0\n- Ability to integrate your API introduction into the side menu\n- High-level grouping in side menu with the [`x-tagGroups`](https://redocly.com/docs/api-reference-docs/specification-extensions/x-tag-groups/) specification extension\n- [Simple integration with `create-react-app`](https://redocly.com/docs/redoc/quickstart/react/)\n- Code samples support (with vendor extension) <br>\n  ![](docs/images/code-samples-demo.gif)\n\n## Usage\n\nRedoc is provided as a CLI tool (also distributed as a Docker image), HTML tag, and React component.\n\n### Generate documentation from the CLI\n\nIf you have Node installed, quickly generate documentation using `npx`:\n\n```\nnpx @redocly/cli build-docs openapi.yaml\n```\n\nThe tool outputs by default to a file named `redoc-static.html` that you can open in your browser.\n\n> [Redocly CLI](https://github.com/Redocly/redocly-cli/) does more than docs; check it out and add linting, bundling, and more to your API workflow.\n\n### Add an HTML element to the page\n\nCreate an HTML page, or edit an existing one, and add the following within the body tags:\n\n```html\n    <redoc spec-url=\"http://petstore.swagger.io/v2/swagger.json\"></redoc>\n    <script src=\"https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\"> </script>\n```\n\nOpen the HTML file in your browser, and your API documentation is shown on the page.\n\nAdd your own `spec-url` to the `<redoc>` tag; this attribute can also be a local file. The JavaScript library can also be installed locally using `npm` and served from your own server, see the [HTML deployment documentation](https://redocly.com/docs/redoc/deployment/html/) for more details.\n\n### More usage options\n\nCheck out the [deployment documentation](./docs/deployment/intro.md) for more options, and detailed documentation for each.\n\n## Redoc vs. Redocly API Reference\n\nRedoc is Redocly's community-edition product. Looking for something more?\nWe also offer [hosted API reference documentation](https://redocly.com/docs/api-registry/guides/api-registry-quickstart/)\nwith additional features including:\n\n* Try-it console\n* Automated code samples\n* Pagination\n* Extra theme options\n\n### Documentation and resources\n\n- [Reference docs](https://redocly.com/docs/api-reference-docs/getting-started/) - we take care of the hosting\n- [Redoc](https://redocly.com/docs/redoc/) - detailed documentation for this open source project (also in the `docs/` folder)\n- [Command-line interface to bundle your docs into a web-ready HTML file](https://redocly.com/docs/cli/commands/build-docs/)\n- API linting, bundling, and much more with open source [Redocly CLI](https://redocly.com/docs/cli)\n\n## Showcase\n\nA sample of the organizations using Redocly tools in the wild:\n\n- [Rebilly](https://api-reference.rebilly.com/)\n- [Docker Engine](https://docs.docker.com/engine/api/v1.25/)\n- [Zuora](https://www.zuora.com/developer/api-reference/)\n- [Discourse](http://docs.discourse.org)\n- [Commbox](https://www.commbox.io/api/)\n- [APIs.guru](https://apis.guru/api-doc/)\n- [BoxKnight](https://www.docs.boxknight.com/)\n- [Quaderno API](https://developers.quaderno.io/api)\n\n_Pull requests to add your own API page to the list are welcome_\n\n## Configuration\n\nRedoc is highly configurable, see the [configuration documentation](docs/config.md) for details.\n\n### OpenAPI specification extensions\nRedoc uses the following [specification extensions](https://redocly.com/docs/api-reference-docs/spec-extensions/):\n\n* [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo\n* [`x-traitTag`](docs/redoc-vendor-extensions.md#x-traitTag) - useful for tags that refer to non-navigation properties like Pagination, Rate-Limits, etc\n* [`x-codeSamples`](docs/redoc-vendor-extensions.md#x-codeSamples) - specify operation code samples\n* [`x-examples`](docs/redoc-vendor-extensions.md#x-examples) - specify JSON example for requests\n* [`x-nullable`](docs/redoc-vendor-extensions.md#x-nullable) - mark schema param as a nullable\n* [`x-displayName`](docs/redoc-vendor-extensions.md#x-displayname) - specify human-friendly names for the menu categories\n* [`x-tagGroups`](docs/redoc-vendor-extensions.md#x-tagGroups) - group tags by categories in the side menu\n* [`x-servers`](docs/redoc-vendor-extensions.md#x-servers) - ability to specify different servers for API (backported from OpenAPI 3.0)\n* [`x-ignoredHeaderParameters`](docs/redoc-vendor-extensions.md#x-ignoredHeaderParameters) - ability to specify header parameter names to ignore\n* [`x-additionalPropertiesName`](docs/redoc-vendor-extensions.md#x-additionalPropertiesName) - ability to supply a descriptive name for the additional property keys\n* [`x-summary`](docs/redoc-vendor-extensions.md#x-summary) - for Response object, use as the response button text, with description rendered under the button\n* [`x-extendedDiscriminator`](docs/redoc-vendor-extensions.md#x-extendedDiscriminator) - in Schemas, uses this to solve name-clash issues with the standard discriminator\n* [`x-explicitMappingOnly`](docs/redoc-vendor-extensions.md#x-explicitMappingOnly) - in Schemas, display a more descriptive property name in objects with additionalProperties when viewing the property list with an object\n\n## Releases\n\n**The README for the `1.x` version is on the [v1.x](https://github.com/Redocly/redoc/tree/v1.x) branch.**\n\nAll the 2.x releases are deployed to npm and can be used with Redocly-cdn:\n- particular release, for example, `v2.0.0`: https://cdn.redoc.ly/redoc/v2.0.0/bundles/redoc.standalone.js\n- `latest` release: https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js\n\nAdditionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(deprecated)**:\n- particular release, for example `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js\n- `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js\n- `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js - points to latest 1.x.x release since 2.x releases are not hosted on this CDN but on unpkg.\n\n\n## Development\nsee [CONTRIBUTING.md](.github/CONTRIBUTING.md)\n","readmeFilename":"README.md","homepage":"https://github.com/aleung/redoc#readme","bugs":{"url":"https://github.com/aleung/redoc/issues"}}