Skip to content

Commit

Permalink
Adds comparison table and OpenAPI link section
Browse files Browse the repository at this point in the history
  • Loading branch information
HCloward committed Oct 9, 2021
1 parent 8d93021 commit 1c8578e
Showing 1 changed file with 51 additions and 13 deletions.
64 changes: 51 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,53 @@ A version of the Swagger Petstore API is displayed by default.
To test it with your own OpenAPI definition,
enter the URL for your definition and select **TRY IT**.

## Redoc vs. Redocly Reference docs

Redoc Community Edition is free open-source software (OSS).
Redocly has developed extensive enhancements on top of Redoc Community Edition's open core, creating Redocly Reference Docs.
See [Comparison Redoc CE vs. Redocly Reference Docs](https://redoc.ly/redoc-vs-reference/)
for the main differences between the Redoc Community Edition and Redocly Reference Docs.

## Deploy to GitHub
[<img alt="Deploy to Github" src="http://i.imgur.com/YZmaqk3.png" height="60px">](https://github.com/Rebilly/generator-openapi-repo#generator-openapi-repo--)

## Redoc as a service
[<img alt="Redoc as a service" src="http://i.imgur.com/edqdCv6.png" height="60px">](https://redoc.ly/workflows)
## Redoc vs. Reference vs. Portals

Redoc is Redocly's community-edition product. Looking for something more?
Checkout the following feature comparison of Redocly's premium products versus Redoc:

| Features | Redoc | Reference | Portals |
|------------------------------|:---------:|:---------:|:-----------:|
| **Specs** | | | |
| Swagger 2.0 ||||
| OpenAPI 3.0 ||||
| OpenAPI 3.1 | √ (basic) |||
| | | | |
| **Theming** | | | |
| Fonts/colors ||||
| Extra theme options | |||
| | | | |
| **Performance** | | | |
| Pagination | |||
| Search (enhanced) | |||
| Search (server-side) | | ||
| | | | |
| **Multiple APIs** | | | |
| Multiple versions | |||
| Multiple APIs | | ||
| API catalog | | ||
| | | | |
| **Additional features** | | | |
| Try-it console | |||
| Automated code samples | |||
| Deep links | |||
| More SEO control | | ||
| Contextual docs | | ||
| Landing pages | | ||
| React hooks for more control | | ||
| Personalization | | ||
| Analytics integrations | | ||
| Feedback | | | Coming Soon |

Refer to the Redocly's documentation for more information on these products:

- [Portals](https://redoc.ly/docs/developer-portal/introduction/)
- [Reference](https://redoc.ly/docs/api-reference-docs/getting-started/)
- [Redoc](https://redoc.ly/docs/redoc/quickstart/intro/)

## Features
- Responsive three-panel design with menu/scrolling synchronization
- [Multiple deployment options](https://redoc.ly/docs/redoc/quickstart/intro/)
- Deep linking support
- [Server-side rendering (SSR) ready](https://redoc.ly/docs/redoc/quickstart/cli/#redoc-cli-commands)
- Ability to integrate your API introduction into the side menu
- [Simple integration with `create-react-app`](https://redoc.ly/docs/redoc/quickstart/react/)
Expand Down Expand Up @@ -99,6 +129,14 @@ Additionally, all the 1.x releases are hosted on our GitHub Pages-based CDN **(d
- [APIs.guru](https://apis.guru/api-doc/)
- [BoxKnight](https://www.docs.boxknight.com/)

## Lint OpenAPI definitions

Redocly's OpenAPI CLI is an open source command-line tool that you can use to lint
your OpenAPI definition. Linting helps you to catch errors and inconsistencies in your
OpenAPI definition before publishing.

Refer to [Lint configuration](https://redoc.ly/docs/cli/guides/lint/) in the OpenAPI documentation for more information.

## Deployment

### TL;DR final code example
Expand Down

0 comments on commit 1c8578e

Please sign in to comment.