Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-10 19:06:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updates per reviews and adds new logo

Browse Source
This commit is contained in:
Heather Cloward 2021-09-22 22:17:19 -04:00
parent 899d7f9637
commit 669adddc9d
2 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -1,5 +1,5 @@
<div align="center"> <div align="center">
<img alt="ReDoc logo" src="https://raw.githubusercontent.com/Redocly/redoc/master/docs/images/redoc-logo.png" width="400px" /> <img alt="ReDoc logo" src="/docs/images/redoc.png" width="400px" />
# Generate interactive API documentation from OpenAPI definitions # Generate interactive API documentation from OpenAPI definitions
@ -13,10 +13,13 @@
## About Redoc ## About Redoc
Redoc is an open-source tool for generating OpenAPI(aka Swagger) definitions. By default Redoc is an open-source tool for generating documentation from OpenAPI (fka Swagger) definitions.
Redoc offers a three-panel, responsive layout: the left panel contains a search bar and navigation menu,
the central panel contains the documentation, and the right panel contains request and response By default Redoc offers a three-panel, responsive layout:
examples.
- The left panel contains a search bar and navigation menu.
- The central panel contains the documentation.
- The right panel contains request and response examples.
![ReDoc demo](https://raw.githubusercontent.com/Redocly/redoc/master/demo/redoc-demo.png) ![ReDoc demo](https://raw.githubusercontent.com/Redocly/redoc/master/demo/redoc-demo.png)

BIN
docs/images/redoc.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.9 KiB