docusaurus-plugin-redoc
Advanced tools
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
Either of spec or specUrl is required (both can also be provided).
A path to a OpenAPI yaml or json file. Will be parsed and forwarded to Redoc component. This has higher priority over specUrl.
A url pointing to an OpenAPI spec. If both are present, then this will be used as download url and spec for rendering.
An object to pass as layout props. Useful to set title/description of the page. See all properties available here.
/api/)Route URL at which docs would be available
@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.
FAQs
Redoc Plugin for DocusaurusV2
The npm package docusaurus-plugin-redoc receives a total of 14,915 weekly downloads. As such, docusaurus-plugin-redoc popularity was classified as popular.
We found that docusaurus-plugin-redoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
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.
Security News
Python becomes GitHub's top language in 2024, driven by AI and data science projects, while AI-powered security tools are gaining adoption.
Security News
Dutch National Police and FBI dismantle Redline and Meta infostealer malware-as-a-service operations in Operation Magnus, seizing servers and source code.
Research
Security News
Socket is tracking a new trend where malicious actors are now exploiting the popularity of LLM research to spread malware through seemingly useful open source packages.