Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-08 06:04:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

changes after feedback

Browse Source 
bad links, wrong cli, etc.!
This commit is contained in:
Ryan Deussing 2020-08-14 18:19:59 -04:00
parent 549c8a3c1f
commit cde68e5fa9
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -48,7 +48,7 @@ The current ReDoc version is `2.0`. For older version please see the [`v1.x`](ht
All of these features are available in our open source community edition. All of these features are available in our open source community edition.
- Deploy **extremely fast** via CDN, npm, CLI, or Docker. - Deploy **extremely fast** via CDN, npm, CLI, or Docker.
- Bundle your docs into a **zero-dependency** HTML file (when using [`redoc-cli`]()). - Bundle your docs into a **zero-dependency** HTML file (when using [`redoc-cli`](#redoc-cli)).
- Integrate with any React app, with client or server-side rendering. - Integrate with any React app, with client or server-side rendering.
- Take full advantage of OpenAPI 2.0/3.0 features, from `discriminator` to `allOf`. - Take full advantage of OpenAPI 2.0/3.0 features, from `discriminator` to `allOf`.
<br> <br> <br> <br>
@ -80,7 +80,7 @@ These features are availale in our hosted or on-premise premium edition.
- Embedded Markdown - Embedded Markdown
## Live Examples ## Live Examples
- [Rebilly](https://rebilly-api.redoc.ly/) - [Rebilly](https://api-reference.rebilly.com)
- [Docker Engine](https://docs.docker.com/engine/api/v1.25/) - [Docker Engine](https://docs.docker.com/engine/api/v1.25/)
- [Zuora](https://www.zuora.com/developer/api-reference/) - [Zuora](https://www.zuora.com/developer/api-reference/)
- [Discourse](http://docs.discourse.org) - [Discourse](http://docs.discourse.org)
@ -96,10 +96,11 @@ These features are availale in our hosted or on-premise premium edition.
- [x] ~~better navigation (menu improvements + search)~~ - [x] ~~better navigation (menu improvements + search)~~
- [x] ~~React rewrite~~ - [x] ~~React rewrite~~
- [x] ~~docs pre-rendering (performance and SEO)~~ - [x] ~~docs pre-rendering (performance and SEO)~~
- [ ] use `redoc-cli` under the hood - [x] add `x-webhooks` support
- [ ] use `openapi-cli` under the hood
- [ ] address accessibility issues - [ ] address accessibility issues
- [ ] add support for links (OpenAPI v3) - [ ] add support for links (OpenAPI v3)
- [ ] add `x-webhooks` support
## Getting Started ## Getting Started