Merge pull request #140 from superfaceai/docu3-experiment

Upgrade to Docusaurus 3

.github/workflows/ci-cd-pipeline.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '16.x'
+          node-version: '18.x'
       - name: Install dependencies
         run: yarn install --frozen-lockfile
 
@@ -41,7 +41,7 @@ jobs:
       - uses: actions/setup-node@v3
         name: Setup Node.js
         with:
-          node-version: lts/*
+          node-version: '18.x'
       - uses: amondnet/vercel-action@v20
         name: Deploy to Vercel
         id: vercel_preview

docs/examples/cloudflare-workers.mdx

@@ -9,7 +9,7 @@ The main difference compared to the Node.js implementation is the need to use a
 This guide assumes that you have already
 installed and run the Superface CLI to generate the Comlinks for the API
 integration you want to work with. If not, please [start
-here](../introduction/quick-start-sdk.mdx).
+here](../introduction/quick-start-sdk).
 
 :::
 

docs/examples/index.mdx

@@ -33,10 +33,7 @@ Below you'll find examples of how to work with Superface's OneSDK in various lan
       <a href="/docs/examples/cloudflare-workers" className="menu__link">
         <div className="card__body">
           <h3>Cloudflare Workers</h3>
-          <p>
-            The Node.js OneSDK with some extra flavour specifically for
-            Cloudflare Workers.
-          </p>
+          <p>The Node.js OneSDK with some extra flavour specifically for Cloudflare Workers.</p>
         </div>
       </a>
     </div>

docs/examples/nodejs.mdx

@@ -7,7 +7,7 @@ In this example, we will go over the steps required to implement Superface into
 This guide assumes that you have already
 installed and run the Superface CLI to generate the Comlinks for the API
 integration you want to work with. If not, please [start
-here](../introduction/quick-start.mdx).
+here](../introduction/quick-start).
 
 :::
 

docs/examples/python.mdx

@@ -5,9 +5,9 @@ In this example, we will go over the steps required to implement Superface into
 :::info Have you created Comlinks?
 
 This guide assumes that you have already
-installed and run the [Superface CLI](../introduction/quick-start.mdx) to generate the Comlinks for the API
+installed and run the [Superface CLI](../introduction/quick-start) to generate the Comlinks for the API
 integration you want to work with. If not, please [start
-here](../introduction/quick-start.mdx).
+here](../introduction/quick-start).
 
 :::
 

docs/index.mdx

@@ -39,10 +39,7 @@ To learn more about Superface and how the CLI acts as the starting point, check
       <a href="/docs/guides/how-to-create" className="menu__link">
         <div className="card__body">
           <h3>🔎 Guides</h3>
-          <p>
-            Looking for more in depth knowledge? Check out our list of guides
-            that get into greater detail.
-          </p>
+          <p>Looking for more in depth knowledge? Check out our list of guides that get into greater detail.</p>
         </div>
       </a>
     </div>
@@ -52,10 +49,7 @@ To learn more about Superface and how the CLI acts as the starting point, check
       <a href="/docs/api-examples" className="menu__link">
         <div className="card__body">
           <h3>💼 Use Case Examples</h3>
-          <p>
-            From HubSpot to Pipedrive. Use case examples demonstrate different
-            uses of Superface with real-world APIs.
-          </p>
+          <p>From HubSpot to Pipedrive. Use case examples demonstrate different uses of Superface with real-world APIs.</p>
         </div>
       </a>
     </div>
@@ -114,8 +108,7 @@ Superface can be mad beneficial! Here are four reasons why we think you should t
     <div className="card shadow">
       <div className="card__body">
         <h3>💸 Developing integrations over and over is expensive</h3>
-        <p>Use integrations developed by others, just as you'd use npm packages or crates.
-        </p>
+        <p>Use integrations developed by others, just as you'd use npm packages or crates.</p>
       </div>
     </div>
   </div>
@@ -124,26 +117,23 @@ Superface can be mad beneficial! Here are four reasons why we think you should t
     <div className="card shadow">
       <div className="card__body">
         <h3>🔐 Your data is safe</h3>
-        <p>Superface isn't a proxy nor a middle-man. Your application connects directly to the API you want to use.
-        </p>
+        <p>Superface isn't a proxy nor a middle-man. Your application connects directly to the API you want to use.</p>
       </div>
     </div>
   </div>
   <div className="col col--6">
     <div className="card shadow">
       <div className="card__body">
         <h3>🎓 Decoupled workflow</h3>
-        <p>This approach gives you a framework to decouple the lifecycle of your application and the integrations it uses.
-        </p>
+        <p>This approach gives you a framework to decouple the lifecycle of your application and the integrations it uses.</p>
       </div>
     </div>
   </div>
     <div className="col col--6">
     <div className="card shadow">
       <div className="card__body">
         <h3>🧐 Abstracted Integrations</h3>
-        <p>Superface is a language and a protocol for abstracting integrations as application use cases. Allowing you to unify your integration approach in code regardless of the API provider.
-        </p>
+        <p>Superface is a language and a protocol for abstracting integrations as application use cases. Allowing you to unify your integration approach in code regardless of the API provider.</p>
       </div>
     </div>
   </div>

package.json

@@ -14,15 +14,91 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.1",
-    "@docusaurus/preset-classic": "^2.0.1",
-    "@svgr/webpack": "^6.3.1",
+    "@algolia/autocomplete-core": "1.9.3",
+    "@algolia/autocomplete-plugin-algolia-insights": "1.9.3",
+    "@algolia/autocomplete-preset-algolia": "1.9.3",
+    "@docsearch/css": "3.5.2",
+    "@docsearch/react": "3.5.2",
+    "@docusaurus/core": "^3.0.0",
+    "@docusaurus/cssnano-preset": "3.0.0",
+    "@docusaurus/plugin-debug": "3.0.0",
+    "@docusaurus/plugin-google-analytics": "3.0.0",
+    "@docusaurus/plugin-google-gtag": "3.0.0",
+    "@docusaurus/plugin-google-tag-manager": "3.0.0",
+    "@docusaurus/plugin-sitemap": "3.0.0",
+    "@docusaurus/preset-classic": "3.0.0",
+    "@docusaurus/theme-classic": "3.0.0",
+    "@docusaurus/theme-search-algolia": "3.0.0",
+    "@mdx-js/mdx": "3.0.0",
+    "@mdx-js/react": "^3.0.0",
+    "@sindresorhus/is": "4.6.0",
+    "@types/prismjs": "1.26.3",
+    "char-regex": "1.0.2",
     "clsx": "^1.2.1",
+    "collapse-white-space": "2.1.0",
+    "emojilib": "2.4.0",
+    "emoticon": "4.0.1",
+    "estree-util-attach-comments": "3.0.0",
+    "estree-util-build-jsx": "3.0.1",
+    "estree-util-to-js": "2.0.0",
+    "estree-util-value-to-estree": "3.0.1",
+    "estree-util-visit": "2.0.0",
+    "fault": "2.0.1",
     "file-loader": "^6.2.0",
+    "format": "0.2.2",
+    "hast-util-from-parse5": "8.0.1",
+    "hast-util-parse-selector": "4.0.0",
+    "hast-util-raw": "9.0.1",
+    "hast-util-to-estree": "3.1.0",
+    "hast-util-to-jsx-runtime": "2.2.0",
+    "hast-util-to-parse5": "8.0.0",
+    "hastscript": "8.0.0",
+    "html-void-elements": "3.0.0",
+    "markdown-extensions": "2.0.0",
+    "mdast-util-directive": "3.0.0",
+    "mdast-util-find-and-replace": "3.0.1",
+    "mdast-util-frontmatter": "2.0.1",
+    "mdast-util-gfm": "3.0.0",
+    "mdast-util-gfm-autolink-literal": "2.0.0",
+    "mdast-util-gfm-footnote": "2.0.0",
+    "mdast-util-gfm-strikethrough": "2.0.0",
+    "mdast-util-gfm-table": "2.0.0",
+    "mdast-util-gfm-task-list-item": "2.0.0",
+    "mdast-util-phrasing": "4.0.0",
+    "micromark": "4.0.0",
+    "micromark-extension-directive": "3.0.0",
+    "micromark-extension-gfm": "3.0.0",
+    "micromark-extension-gfm-autolink-literal": "2.0.0",
+    "micromark-extension-gfm-footnote": "2.0.0",
+    "micromark-extension-gfm-strikethrough": "2.0.0",
+    "micromark-extension-gfm-table": "2.0.0",
+    "micromark-extension-gfm-tagfilter": "2.0.0",
+    "micromark-extension-gfm-task-list-item": "2.0.1",
+    "micromark-extension-mdx-expression": "3.0.0",
+    "micromark-extension-mdx-jsx": "3.0.0",
+    "micromark-extension-mdx-md": "2.0.0",
+    "micromark-extension-mdxjs": "3.0.0",
+    "micromark-extension-mdxjs-esm": "3.0.0",
+    "micromark-factory-destination": "2.0.0",
+    "micromark-factory-label": "2.0.0",
+    "micromark-factory-title": "2.0.0",
+    "micromark-util-html-tag-name": "2.0.0",
+    "node-emoji": "2.1.3",
     "prism-react-renderer": "^1.3.5",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "url-loader": "^4.1.1"
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rehype-raw": "7.0.0",
+    "remark-directive": "3.0.0",
+    "remark-emoji": "4.0.1",
+    "remark-frontmatter": "5.0.0",
+    "remark-gfm": "4.0.0",
+    "remark-mdx": "3.0.0",
+    "remark-rehype": "11.0.0",
+    "remark-stringify": "11.0.0",
+    "skin-tone": "2.0.0",
+    "unicode-emoji-modifier-base": "1.0.0",
+    "unist-util-remove-position": "5.0.0",
+    "vfile-location": "5.0.2"
   },
   "browserslist": {
     "production": [
@@ -37,6 +113,10 @@
     ]
   },
   "devDependencies": {
+    "@docusaurus/module-type-aliases": "3.0.0",
     "prettier": "2.7.1"
+  },
+  "engines": {
+    "node": ">=18"
   }
 }

tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "@docusaurus/tsconfig",
+  "compilerOptions": {
+    "baseUrl": "."
+  }
+}