Docusaurus v3.6 - enable Docusaurus Faster (#1003)

* stable docusaurus-faster setup * mention Docusaurus Faster in readme * 3.6 stable * 3.6 stable
PaloAltoNetworks · Nov 4, 2024 · 9163472 · 9163472
1 parent e7295a8
commit 9163472
Show file tree

Hide file tree

Showing 5 changed files with 1,598 additions and 308 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 <div align="center">
 
-OpenAPI plugin for generating API reference docs in Docusaurus v3.
+OpenAPI plugin for generating API reference docs in Docusaurus v3 (compatible with [Docusaurus Faster](https://github.com/facebook/docusaurus/issues/10556).
 
 <img src="https://img.shields.io/badge/dynamic/json?style=for-the-badge&logo=meta&color=blueviolet&label=Docusaurus&query=dependencies%5B%22%40docusaurus%2Fcore%22%5D&url=https%3A%2F%2Fraw.githubusercontent.com%2FPaloAltoNetworks%2Fdocusaurus-openapi-docs%2Fmain%2Fdemo%2Fpackage.json" />
 <br/><br/>

diff --git a/demo/docusaurus.config.ts b/demo/docusaurus.config.ts
@@ -7,6 +7,10 @@ import { DOCUSAURUS_VERSION } from "@docusaurus/utils";
 import { myCustomApiMdGenerator } from "./customMdGenerators";
 
 const config: Config = {
+  future: {
+    experimental_faster: (process.env.DOCUSAURUS_FASTER ?? "true") === "true",
+  },
+
   title: "Docusaurus OpenAPI Docs",
   tagline: "OpenAPI plugin for generating API reference docs in Docusaurus v2",
   url: "https://docusaurus-openapi.tryingpan.dev",

diff --git a/demo/package.json b/demo/package.json
@@ -21,9 +21,10 @@
     "re-gen": "yarn clean-all && yarn gen-all"
   },
   "dependencies": {
-    "@docusaurus/core": "3.5.2",
-    "@docusaurus/plugin-google-gtag": "3.5.2",
-    "@docusaurus/preset-classic": "3.5.2",
+    "@docusaurus/core": "3.6.0",
+    "@docusaurus/faster": "3.6.0",
+    "@docusaurus/plugin-google-gtag": "3.6.0",
+    "@docusaurus/preset-classic": "3.6.0",
     "clsx": "^1.1.1",
     "docusaurus-plugin-openapi-docs": "^4.2.0",
     "docusaurus-theme-openapi-docs": "^4.2.0",

diff --git a/packages/docusaurus-theme-openapi-docs/package.json b/packages/docusaurus-theme-openapi-docs/package.json
@@ -47,7 +47,7 @@
     "docusaurus-plugin-sass": "^0.2.3",
     "file-saver": "^2.0.5",
     "lodash": "^4.17.20",
-    "node-polyfill-webpack-plugin": "^2.0.1",
+    "node-polyfill-webpack-plugin": "^3.0.0",
     "postman-code-generators": "^1.10.1",
     "postman-collection": "^4.4.0",
     "prism-react-renderer": "^2.3.0",