Bump to Docusaurus 3.1.0

oasisprotocol · Jan 8, 2024 · defb295 · defb295
1 parent b8b24ec
commit defb295
Show file tree

Hide file tree

Showing 14 changed files with 287 additions and 282 deletions.
diff --git a/README.md b/README.md
@@ -99,7 +99,7 @@ accordingly.
 
 While all markdown files inside `docs` are compiled, not all files may be
 reachable via sidebars directly. Each top-level chapter defines own
-sidebar structure inside their `sidebarChapterName.js` file.
+sidebar structure inside their `sidebarChapterName.ts` file.
 
 Nouns, adjectives and verbs in the titles should be capitalized.
 
@@ -174,7 +174,7 @@ To define the region in the referenced file put `#region some-region-name` and
 
 When you move, rename or delete previously published content, make sure that
 **any previously valid URL will always point to the new valid location**. Set
-up redirects in `redirects.js` accordingly and leave the pull request
+up redirects in `redirects.ts` accordingly and leave the pull request
 number in the comment which added this redirection for future reference, if
 major rewrite is to happen and the developers would need more context around
 the redirection.

diff --git a/docusaurus.config.js → docusaurus.config.ts b/docusaurus.config.js → docusaurus.config.ts
@@ -1,14 +1,14 @@
-// @ts-check
-// Note: type annotations allow type checking and IDEs autocompletion
-
 import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
 
 import {editLinkUrl as editUrlFunction} from './src/editUrl';
 import crossRepoLinksPlugin from './src/remark/cross-repo-links';
 import codeBlockSnippetsPlugin from './src/remark/code-block-snippets';
+import {redirectsOptions} from './redirects';
+import {sidebars} from './sidebars';
 
-/** @type {import('@docusaurus/types').Config} */
-const config = {
+const config: Config = {
   title: 'Oasis Documentation',
   tagline: '',
   url: process.env.URL ?? 'https://docs.oasis.io',
@@ -19,11 +19,15 @@ const config = {
   projectName: 'docs', // Usually your repo name.
   deploymentBranch: 'gh-pages',
 
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
   presets: [
     [
       'classic',
-      /** @type {import('@docusaurus/preset-classic').Options} */
-      ({
+      {
         docs: {
           breadcrumbs: false,
           editUrl: editUrlFunction,
@@ -43,13 +47,13 @@ const config = {
           ],
           routeBasePath: '/',
           showLastUpdateTime: true,
-          sidebarPath: require.resolve('./sidebars.js'),
+          sidebarPath: './sidebars.ts',
         },
         blog: false,
         theme: {
           customCss: require.resolve('./src/css/custom.css'),
         },
-      }),
+      } satisfies Preset.Options,
     ],
   ],
   plugins: [
@@ -67,7 +71,7 @@ const config = {
     },
     [
       '@docusaurus/plugin-client-redirects',
-      require('./redirects.js'),
+      redirectsOptions,
     ],
   ],
   themes: [
@@ -80,8 +84,7 @@ const config = {
     ],
   ],
   themeConfig:
-    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
-    ({
+    {
       navbar: {
         title: 'Oasis Docs',
         logo: {
@@ -238,7 +241,7 @@ Apache 2.0</a>. Built with &#x2665; and Docusaurus.</p>`,
       colorMode: {
         respectPrefersColorScheme: true,
       },
-    }),
+    } satisfies Preset.ThemeConfig,
 };
 
 module.exports = config;
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "docs-oasis-dev",
+  "name": "docs-oasis-io",
   "version": "0.0.0",
   "private": true,
   "scripts": {
@@ -14,15 +14,16 @@
     "test": "jest src",
     "write-translations": "docusaurus write-translations",
     "write-heading-ids": "docusaurus write-heading-ids",
+    "typecheck": "tsc",
     "blc": "linkinator http://localhost:3000 --config linkinator.config.json",
     "lint-markdown": "markdownlint-cli2 'docs/**/*.md' 'docs/**/*.mdx'",
     "fmt-markdown": "markdownlint-cli2-fix 'docs/**/*.md' 'docs/**/*.mdx'"
   },
   "dependencies": {
-    "@docusaurus/core": "^3.0.1",
-    "@docusaurus/plugin-client-redirects": "^3.0.1",
-    "@docusaurus/preset-classic": "^3.0.1",
-    "@docusaurus/remark-plugin-npm2yarn": "^3.0.1",
+    "@docusaurus/core": "^3.1.0",
+    "@docusaurus/plugin-client-redirects": "^3.1.0",
+    "@docusaurus/preset-classic": "^3.1.0",
+    "@docusaurus/remark-plugin-npm2yarn": "^3.1.0",
     "@easyops-cn/docusaurus-search-local": "^0.40.1",
     "@mdx-js/react": "^3.0.0",
     "@mermaid-js/mermaid-cli": "^10.6.1",
@@ -51,6 +52,13 @@
   "devDependencies": {
     "@types/plotly.js-basic-dist": "^1.54.4",
     "@types/react-plotly.js": "^2.6.3",
-    "jest": "^29.7.0"
+    "@docusaurus/module-type-aliases": "^3.1.0",
+    "@docusaurus/tsconfig": "^3.1.0",
+    "@docusaurus/types": "^3.1.0",
+    "jest": "^29.7.0",
+    "typescript": "~5.2.2"
+  },
+  "engines": {
+    "node": ">=18.0"
   }
 }
diff --git a/redirects.js → redirects.ts b/redirects.js → redirects.ts
@@ -1,7 +1,6 @@
-// @ts-check
+import PluginOptions from '@docusaurus/plugin-client-redirects';
 
-/** @type {import('@docusaurus/plugin-client-redirects').PluginOptions} */
-const redirectsOptions = {
+export const redirectsOptions: PluginOptions = {
     redirects: [
         // Write down PR responsible for the removal of a page next to the "from" redirect.
         // TODO: Add fragments (anchors) in "to" URLs once https://github.com/facebook/docusaurus/issues/6845 is implemented. Since then, put the fragment name in the comment.
@@ -270,5 +269,3 @@ const redirectsOptions = {
         return undefined;
     },
 };
-
-module.exports = redirectsOptions
diff --git a/sidebarAdrs.js → sidebarAdrs.ts b/sidebarAdrs.js → sidebarAdrs.ts
@@ -1,7 +1,6 @@
-// @ts-check
+import {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
+export const sidebarAdrs: SidebarsConfig = {
   adrs: [
     {
       type: 'category',
@@ -20,5 +19,3 @@ const sidebars = {
     }
   ],
 };
-
-module.exports = sidebars;
diff --git a/sidebarCore.js → sidebarCore.ts b/sidebarCore.js → sidebarCore.ts
@@ -1,7 +1,6 @@
-// @ts-check
+import {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
+export const sidebarCore: SidebarsConfig = {
   oasisCore: [
     {
       type: 'doc',
@@ -174,5 +173,3 @@ const sidebars = {
     },
   ],
 };
-
-module.exports = sidebars;
diff --git a/sidebarDapp.js → sidebarDapp.ts b/sidebarDapp.js → sidebarDapp.ts
@@ -1,7 +1,6 @@
-// @ts-check
+import {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
+export const sidebarDapp: SidebarsConfig = {
   developers: [
     {
       type: 'doc',
@@ -84,5 +83,3 @@ const sidebars = {
     },
   ],
 };
-
-module.exports = sidebars;
diff --git a/sidebarGeneral.js → sidebarGeneral.ts b/sidebarGeneral.js → sidebarGeneral.ts
@@ -1,7 +1,6 @@
-// @ts-check
+import {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
+export const sidebarGeneral: SidebarsConfig = {
   general: [
     {
       type: 'doc',
@@ -87,5 +86,3 @@ const sidebars = {
     },
   ],
 };
-
-module.exports = sidebars;
diff --git a/sidebarGetInvolved.js → sidebarGetInvolved.ts b/sidebarGetInvolved.js → sidebarGetInvolved.ts
@@ -1,7 +1,6 @@
-// @ts-check
+import {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
+export const sidebarGetInvolved: SidebarsConfig = {
   getInvolved: [
     'get-involved/README',
     {
@@ -48,5 +47,3 @@ const sidebars = {
     'get-involved/token-delivery-and-kyc',
   ],
 };
-
-module.exports = sidebars;
diff --git a/sidebarNode.js → sidebarNode.ts b/sidebarNode.js → sidebarNode.ts
@@ -1,7 +1,6 @@
-// @ts-check
+import {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
+export const sidebarNode: SidebarsConfig = {
   operators: [
     {
       type: 'doc',
@@ -134,5 +133,3 @@ const sidebars = {
     },
   ],
 };
-
-module.exports = sidebars;
diff --git a/sidebarParatime.js → sidebarParatime.ts b/sidebarParatime.js → sidebarParatime.ts
@@ -1,7 +1,6 @@
-// @ts-check
+import {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
+export const sidebarParaTime: SidebarsConfig = {
   paratime: [
     {
       type: 'doc',
@@ -29,5 +28,3 @@ const sidebars = {
     },
   ],
 };
-
-module.exports = sidebars;
diff --git a/sidebars.js b/sidebars.js
diff --git a/sidebars.ts b/sidebars.ts
@@ -0,0 +1,21 @@
+import {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+
+import {sidebarAdrs} from './sidebarAdrs';
+import {sidebarCore} from './sidebarCore';
+import {sidebarDapp} from './sidebarDapp';
+import {sidebarGeneral} from './sidebarGeneral';
+import {sidebarGetInvolved} from './sidebarGetInvolved';
+import {sidebarNode} from './sidebarNode';
+import {sidebarParaTime} from './sidebarParatime';
+
+const sidebars: SidebarsConfig = {
+  ...sidebarAdrs,
+  ...sidebarCore,
+  ...sidebarDapp,
+  ...sidebarGeneral,
+  ...sidebarGetInvolved,
+  ...sidebarNode,
+  ...sidebarParaTime,
+};
+
+export default sidebars;