{"repo":"PaloAltoNetworks/docusaurus-openapi-docs","free":true,"listed":false,"github":"https://github.com/PaloAltoNetworks/docusaurus-openapi-docs","clone":"git clone https://github.com/PaloAltoNetworks/docusaurus-openapi-docs.git","description":"🦝 OpenAPI plugin for generating API reference docs in Docusaurus v3.","language":"TypeScript","stars":1100,"topics":["docusaurus","docusaurus-plugin","docusaurus-theme","docusaurus2","openapi","react"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Docusaurus OpenAPI Doc Generator OpenAPI plugin for generating API reference docs in Docusaurus v3 (compatible with Docusaurus Faster). --- Overview The docusaurus-plugin-openapi-docs package extends the Docusaurus CLI with commands for generating MDX using the OpenAPI specification as the source. The resulting MDX is fully compatible with plugin-content-docs and can be used to render beautiful reference API docs when combined with the docusaurus-theme-openapi-docs theme. Key Features: - Compatible: Works with Swagger 2.0 and OpenAPI 3.x. - Fast: Convert large OpenAPI specs into MDX docs in seconds. 🔥 - Stylish: Based on the same Infima styling framework that powers the Docusaurus UI. - Flexible: Supports single, multi and even micro OpenAPI specs. - Extensible: Recognizes common vendor extensions for customizing your docs. See Supported Vendor Extensions for details. Compatibility Matrix Docusaurus OpenAPI Docs Docusaurus ----------------------- --------------- 5.x.x (current) 3.10.0+ 4.x.x (legacy) 3.5.0 - 3.9.2 3.0.x (end-of-support) 3.0.1 - 3.4.0 2.2.3 (end-of-support) 2.4.1 - 2.4.3 1.7.3 (end-of-support) 2.0.1 - 2.2.0 Quick Start (new Docusaurus site) Run the following to bootstrap a Docusaurus v3 site (classic theme) with docusaurus-openapi-docs : If all goes well, you should be greeted by a brand new Docusaurus site that includes API reference docs for the ubiquitous Petstore API! CLI Options Option Description --------------------------------- -----------------------","default_branch":null,"files":null,"tree":[],"storefront":"/r/PaloAltoNetworks","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/PaloAltoNetworks/docusaurus-openapi-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}