Giter Site home page Giter Site logo

junjiewang / redocusaurus Goto Github PK

View Code? Open in Web Editor NEW

This project forked from rohit-gohri/redocusaurus

0.0 1.0 0.0 20.93 MB

OpenAPI for Docusaurus v2 with Redoc

Home Page: https://redocusaurus.vercel.app/

License: MIT License

JavaScript 28.47% CSS 18.00% TypeScript 49.60% Shell 3.94%

redocusaurus's Introduction

Redocusaurus

npm npm Libraries.io dependency status for latest release Typed with TypeScript Build and Deploy GitHub branch checks state This project is using Percy.io for visual regression testing.

Redoc for Docusaurus v2.

Usage

Check the documentation on the website.

Demo

See Examples

Packages

Redocusaurus

A Docusaurus Preset that combines the below 2 packages to easily add API doc(s) to your docs site.

Docusaurus Theme Redoc

A wrapper around RedocStandalone to make it match the Dcousaurus Theme with added support for Dark Mode.

Docusaurus Plugin Redoc

A content plugin that creates pages from your OpenAPI files or URLs and renders them using the Redoc component from the theme.

Website

Docs website and example project show casing the preset in action with multiple different OpenAPI specs.

Who is using Redocusaurus?

See Who is using Redocusaurus? section in docs.

Contributing

Any help is greatly appreciated, check the DEVELOPMENT.md for help on how to setup the project in your local and CONTRIBUTING.md for general info about the contribution workflow.

Motivation

To have the documentation and API reference in the same site with the same headers/footers. Read more in the blog post, OpenAPI for Docusaurus.

See this issue, https://github.com/facebook/docusaurus/issues/638, and this gist, https://gist.github.com/rohit-gohri/b1a19f37702cfe4a6c5a47933a11785b for more details and history.

License

MIT License. Copyright (c) 2022 Rohit Gohri

redocusaurus's People

Contributors

rohit-gohri avatar github-actions[bot] avatar dependabot[bot] avatar awarrenlove avatar erickreutz avatar serut avatar qin-guan avatar homotechsual avatar joshtemple avatar aerovulpe avatar zhao-andy avatar artflag avatar huan avatar zerkms avatar jeff1010322 avatar michieldemey avatar mkrtchian avatar

Watchers

James Cloos 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.