Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

docusaurus-plugin-redoc

Package Overview
Dependencies
Maintainers
1
Versions
59
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

docusaurus-plugin-redoc

Redoc Plugin for DocusaurusV2

  • 0.9.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
16K
decreased by-13.09%
Maintainers
1
Weekly downloads
 
Created
Source

Docusaurus Plugin Redoc

npm

This plugin parses your OpenAPI spec files and creates pages using the ApiDoc component from your theme. Use with docusaurus-theme-redoc.

Read More Here: https://github.com/rohit-gohri/redocusaurus

Options

Either of spec or specUrl is required (both can also be provided).

spec

A path to a OpenAPI yaml or json file. Will be parsed and forwarded to Redoc component. This has higher priority over specUrl.

specUrl

A url pointing to an OpenAPI spec. If both are present, then this will be used as download url and spec for rendering.

layout

An object to pass as layout props. Useful to set title/description of the page. See all properties available here.

routePath (default: /api/)

Route URL at which docs would be available

apiDocComponent (default: @theme/ApiDoc)

If you want to use a custom component to render the spec instead of the one with docusaurus-theme-redoc then overwrite this with a path to the component. It will be forwarded a single prop, see ApiDoc for example.

Docs

See: https://rohit-gohri.github.io/redocusaurus/doc

Keywords

FAQs

Package last updated on 05 Mar 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc