https://github.com/pointnet/redoc-editor

Edit and share ReDoc settings/theme
https://github.com/pointnet/redoc-editor

openapi react redoc redoc-editor

Last synced: 3 months ago
JSON representation

Edit and share ReDoc settings/theme

• Host: GitHub
• URL: https://github.com/pointnet/redoc-editor
• Owner: pointnet
• License: mit
• Created: 2019-07-24T10:40:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T05:14:23.000Z (almost 2 years ago)
• Last Synced: 2024-04-06T22:34:51.279Z (7 months ago)
• Topics: openapi, react, redoc, redoc-editor
• Language: JavaScript
• Homepage: https://pointnet.github.io/redoc-editor
• Size: 5.76 MB
• Stars: 13
• Watchers: 1
• Forks: 2
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-docs - Redoc-Editor

README

        
# redoc-editor

> Edit and share ReDoc settings/theme

![redoc-editor demo](https://raw.githubusercontent.com/pointnet/redoc-editor/master/.github/overview.png)

## [Live demo](http://pointnet.github.io/redoc-editor/)

This project was bootstrapped with

* [redoc](https://github.com/Redocly/redoc) - OpenAPI/Swagger-generated API Reference Documentation

* [create-react-app](https://github.com/facebook/create-react-app) - Set up a modern web app by running one command

* [material-ui](https://github.com/mui-org/material-ui) - React components for faster and easier web development

* [immer](https://github.com/immerjs/immer) - Create the next immutable state by mutating the current one

* [react-color](https://github.com/casesandberg/react-color) - Color Pickers from Sketch, Photoshop, Chrome, Github, Twitter & more

* [react-custom-scrollbars](https://github.com/malte-wessel/react-custom-scrollbars) - React scrollbars component

* [react-highlight](https://github.com/akiran/react-highlight) - React component for syntax highlighting

* [react-router-dom](https://github.com/ReactTraining/react-router) - Declarative routing for React

* [yup](https://github.com/jquense/yup) - Dead simple Object schema validation

This project use a modified version of the [Petstore](https://redocly.github.io/redoc/openapi.yaml)

OpenAPI definition from [ReDoc](https://github.com/Redocly/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](/.github/CONTRIBUTING.md) you make.


For bugs and feature requests, [please create an issue](../../issues/new).


Pull requests and stars are always welcome. :)

## License

This project is licensed under the terms of the [MIT license](/LICENSE).