Giter VIP home page Giter VIP logo

redoc-editor's Introduction

redoc-editor

Edit and share ReDoc settings/theme

redoc-editor 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.

redoc-editor's People

Contributors

pointnet avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.