tillkolter / redoc-editor

Edit and share ReDoc settings/theme

redoc-editor

Edit and share ReDoc settings/theme

Live demo

This project was bootstrapped with

• redoc - OpenAPI/Swagger-generated API Reference Documentation
• create-react-app - Set up a modern web app by running one command
• material-ui - React components for faster and easier web development
• immer - Create the next immutable state by mutating the current one
• react-color - Color Pickers from Sketch, Photoshop, Chrome, Github, Twitter & more
• react-custom-scrollbars - React scrollbars component
• react-highlight - React component for syntax highlighting
• react-router-dom - Declarative routing for React
• yup - Dead simple Object schema validation

This project use a modified version of the Petstore OpenAPI definition from ReDoc.

This was done to remove the Authentication block from the info.description definition so we can see the effect of the noAutoAuth option.

Todo

fontFamily picker, right now you can't edit

• typography.fontFamily
• typography.headings.fontFamily
• typography.code.fontFamily

scrollYOffset picker: querySelector or number or function

jsonSampleExpandLevel picker: allow all or number (default: 2)

showExtensions picker: allow comma separated list of vendor extension

Contributing

We'd greatly appreciate any contribution you make.
For bugs and feature requests, please create an issue.
Pull requests and stars are always welcome. :)

License

This project is licensed under the terms of the MIT license.