Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-26 02:23:43 +03:00
Code Issues Packages Projects Releases Wiki Activity

add features to readme

Browse Source
This commit is contained in:
Roman Hotsiy 2016-08-01 08:15:52 +03:00
parent 5111abf1d4
commit f65c4b3de3
No known key found for this signature in database
GPG Key ID: 5CB7B3ACABA57CB0
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -11,6 +11,15 @@
## [Live demo](http://rebilly.github.io/ReDoc/)
## Features
- Extremely easy deployment
- It’s free and open-source project under MIT license
- The widest OpenAPI features support (yes, it supports even discriminator)
- Neat documentation for nested objects
- Code samples support (via vendor extension)
- 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.
## Roadmap
- [ ] docs pre-rendering (performance and SEO)
- [ ] ability to simple customization