Upgrade Docusaurus from 3.7.0 to 3.9.2 (#1011)

* Upgrade Docusaurus from 3.7.0 to 3.9.1

* Move `onBrokenMarkdownLinks` to markdown hooks

The onBrokenMarkdownLinks option was removed from the root config and added under markdown.hooks to align with updated Docusaurus configuration structure. This change complies with a change made in Docusaurus 3.9: facebook/docusaurus#11283

* Add `onDuplicateRoutes` configuration

* Change version number in description

* Update Node.js version to `20`

Bump Node.js version from `18` to `20` in deploy and test-deploy GitHub Actions workflows to ensure compatibility with the latest Node.js features and security updates. This is necessary because Docusaurus 3.9 drops support for Node.js 18: https://docusaurus.io/blog/releases/3.9#dropping-nodejs-18

* Ensure output directory exists before writing JSON

Added logic to create the output directory if it does not exist before writing the glossary JSON file. This prevents errors when the specified output path's directory is missing.

* Add `key` attributes for labels with duplicate names

When labels have duplicate names, the sidebar must contain a `key` attribute. Without these `key` attributes, Docusaurus 3.9 (and likely later unless this specification changes) will encounter errors during the build process.

As described in the Docusaurus blog post for 3.9: "In #11228, we added a new `key` attribute to the docs sidebar items, allowing to assign explicit translation keys to each sidebar item that use the same label and would otherwise lead to translation key conflicts."

Related Docusaurus PR: facebook/docusaurus#11228

* Add `colorMode` to respect user's light/dark theme preference

Introduced a colorMode section in the Docusaurus config to set the default mode to light, enable the color mode switch, and respect the user's preferred color scheme.

* Change `current` to version number (`3.12`)

* Change format of `key` values

Addresses: #1011 (comment)
Co-Authored-By: Jun Nemoto <[email protected]>

* Upgrade Docusaurus form 3.9.1 to 3.9.2

---------

Co-authored-by: Jun Nemoto <[email protected]>

Author: josh-wong

.github/workflows/deploy.yml

@@ -18,7 +18,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: npm
       - name: Install Python dependencies
         run: |

.github/workflows/test-deploy.yml

@@ -18,7 +18,7 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: npm
 
       - name: Install dependencies

docusaurus.config.js

@@ -24,8 +24,8 @@ const config = {
   projectName: 'docs-scalardl', // Usually your repo name.
 
   onBrokenLinks: 'warn',
-  onBrokenMarkdownLinks: 'ignore',
   onBrokenAnchors: 'ignore',
+  onDuplicateRoutes: 'warn',
 
   // Even if you don't use internationalization, you can use this field to set
   // useful metadata like html lang. For example, if your site is Chinese, you
@@ -283,6 +283,9 @@ const config = {
   ],
   markdown: {
     mermaid: true,
+    hooks: {
+      onBrokenMarkdownLinks: 'ignore',
+    },
   },
   themes: ['@docusaurus/theme-mermaid'],
 
@@ -472,6 +475,11 @@ const config = {
         textColor: '#FFFFFF',
         isCloseable: false,
       },
+      colorMode: {
+        defaultMode: 'light',
+        disableSwitch: false,
+        respectPrefersColorScheme: true,
+      },
       zoom: {
         selector: '.markdown :not(em) > img:not(.youtube-embed img)',
         background: {

i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.10.json

@@ -1,7 +1,7 @@
 {
   "version.label": {
     "message": "3.10",
-    "description": "The label for version current"
+    "description": "The label for version 3.10"
   },
   "sidebar.docs.category.About ScalarDL": {
     "message": "ScalarDL について",

i18n/versioned_docs/ja-jp/docusaurus-plugin-content-docs/version-3.11.json

@@ -1,7 +1,7 @@
 {
   "version.label": {
     "message": "3.11",
-    "description": "The label for version current"
+    "description": "The label for version 3.11"
   },
   "sidebar.docs.category.About ScalarDL": {
     "message": "ScalarDL について",