docusaurus-plugin-openapi-docs 0.0.0-616 → 0.0.0-617

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +8 -1
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -22,7 +22,7 @@ The `docusaurus-plugin-openapi-docs` package extends the Docusaurus CLI with com
22
22
 
23
23
  Key Features:
24
24
 
25
- - **Compatible:** Works with Swagger 2.0 and OpenAPI 3.x.
25
+ - **Compatible:** Works with Swagger 2.0 and OpenAPI 3.0.
26
26
  - **Fast:** Convert large OpenAPI specs into MDX docs in seconds. 🔥
27
27
  - **Stylish:** Based on the same [Infima styling framework](https://infima.dev/) that powers the Docusaurus UI.
28
28
  - **Capable:** Supports single, multi and _even micro_ OpenAPI specs.
@@ -41,6 +41,13 @@ Theme:
41
41
  yarn add docusaurus-theme-openapi-docs
42
42
  ```
43
43
 
44
+ ## Compatibility Matrix
45
+
46
+ | Docusaurus OpenAPI Docs | Docusaurus |
47
+ | ----------------------- | ---------------- |
48
+ | 1.x.x | `>=2.0.1 <2.3.0` |
49
+ | 2.x.x (beta) | `>=2.3.0 <2.4.1` |
50
+
44
51
  ## Configuring `docusaurus.config.js` (Plugin and theme usage)
45
52
 
46
53
  Here is an example of properly configuring your `docusaurus.config.js` file for `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` usage.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "docusaurus-plugin-openapi-docs",
3
3
  "description": "OpenAPI plugin for Docusaurus.",
4
- "version": "0.0.0-616",
4
+ "version": "0.0.0-617",
5
5
  "license": "MIT",
6
6
  "keywords": [
7
7
  "openapi",
@@ -68,5 +68,5 @@
68
68
  "engines": {
69
69
  "node": ">=14"
70
70
  },
71
- "gitHead": "8ba8a83ca6b3bd116a0a2bab85594d719b76b749"
71
+ "gitHead": "497549c580de64c1df8b91e6b7a7f283e8defb85"
72
72
  }