[V3] Improved Docusaurus 3 compatibility (#677)

* Introduce clean function for escaping headers and descriptions * Remove escape from codeblocks * Add typing to sidebar generation * Update Docusaurus dependencies in packages * Use improved TypeScript support of Docusaurus for demo * Update tests
PaloAltoNetworks · Dec 13, 2023 · 20a21b0 · 20a21b0
1 parent 9e57319
commit 20a21b0
Show file tree

Hide file tree

Showing 38 changed files with 1,393 additions and 867 deletions.
diff --git a/.gitignore b/.gitignore
@@ -137,6 +137,6 @@ dist
 demo/**/*.api.mdx
 demo/**/*.info.mdx
 demo/**/*.tag.mdx
-demo/**/sidebar.js
+demo/**/sidebar.ts
 demo/**/versions.json
 
diff --git a/.prettierrc.json b/.prettierrc.json
@@ -1 +1,3 @@
-{}
+{
+  "trailingComma": "es5"
+}
diff --git a/demo/docs/customization/languagetabs.md → demo/docs/customization/languagetabs.mdx b/demo/docs/customization/languagetabs.md → demo/docs/customization/languagetabs.mdx
diff --git a/demo/docs/customization/styling.md → demo/docs/customization/styling.mdx b/demo/docs/customization/styling.md → demo/docs/customization/styling.mdx
diff --git a/demo/docs/sidebars.md → demo/docs/sidebars.mdx b/demo/docs/sidebars.md → demo/docs/sidebars.mdx
diff --git a/demo/docs/versioning.md → demo/docs/versioning.mdx b/demo/docs/versioning.md → demo/docs/versioning.mdx
@@ -78,7 +78,7 @@ Import:
 
 ```javascript
 const {
-  versionSelector,
+  versionSelector
 } = require("docusaurus-plugin-openapi-docs/lib/sidebars/utils"); // imports utility
 const petstoreVersions = require("./docs/petstore/versions.json"); // imports Petstore versions.json
 ```
@@ -102,7 +102,7 @@ Import:
 
 ```javascript
 const {
-  versionCrumb,
+  versionCrumb
 } = require("docusaurus-plugin-openapi-docs/lib/sidebars/utils");
 ```
 

diff --git a/demo/docusaurus.config.js b/demo/docusaurus.config.js