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

Update README.md

Browse Source
This commit is contained in:
Roman Hotsiy 2016-12-02 08:00:14 +02:00 committed by GitHub
parent b29da8cb1b
commit 0e8402aa0a
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -18,19 +18,24 @@
## Features ## Features
- Extremely easy deployment - Extremely easy deployment
- It’s free and open-source project under MIT license - It’s free and open-source project under MIT license
- The widest OpenAPI features support (yes, it supports even discriminator) - The widest OpenAPI features support (yes, it supports even `discriminator`)
- Neat documentation for nested objects - Neat **interactive** documentation for nested objects
<img src="http://i.imgur.com/260gaV4.png" width="500">
- Code samples support (via vendor extension) - Code samples support (via vendor extension)
- Responsive three-panel design with menu/scrolling synchronization - Responsive three-panel design with menu/scrolling synchronization
- Integrate API introduction into side menu - ReDoc takes advantage of markdown headings from OpenAPI description field. It pulls them into side menu and also supports deep linking. - Integrate API introduction into side menu - ReDoc takes advantage of markdown headings from OpenAPI description field. It pulls them into side menu and also supports deep linking.
## Roadmap ## Roadmap
- [ ] docs pre-rendering (performance and SEO) - [x] performance optimizations
- [ ] ability to simple customization - [ ] better navigation (menu improvements + search)
- [ ] ability to simple branding/styling
- [ ] built-in API Console - [ ] built-in API Console
- [ ] docs pre-rendering (performance and SEO)
## Releases ## Releases
We host latest and all the previous ReDoc releases on GitHub Pages-based **CDN**: We host the latest and all the previous ReDoc releases on GitHub Pages-based **CDN**:
- particular release, e.g. `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js - particular release, e.g. `v1.2.0`: https://rebilly.github.io/ReDoc/releases/v1.2.0/redoc.min.js
- `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js - `v1.x.x` release: https://rebilly.github.io/ReDoc/releases/v1.x.x/redoc.min.js
- `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js **[not for production]** - `latest` release: https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js **[not for production]**