Merge pull request #106 from gosling-lang/sehilyi/docusaurus-3

feat: update to docusaurus v3

.github/workflows/deploy_action.yml

@@ -16,7 +16,7 @@ jobs:
           submodules: 'true'
       - uses: actions/setup-node@v1
         with:
-          node-version: '16.x'
+          node-version: '18.x'
       - name: Test Build
         run: |
           if [ -e yarn.lock ]; then
@@ -36,7 +36,7 @@ jobs:
             submodules: true
       - uses: actions/setup-node@v1
         with:
-          node-version: '16.x'
+          node-version: '18.x'
       - name: Test Build
         run: |
           if [ -e yarn.lock ]; then
@@ -56,4 +56,4 @@ jobs:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
           AWS_REGION: 'us-east-1'  
-          SOURCE_DIR: 'build'      # optional: defaults to entire repository
+          SOURCE_DIR: 'build'      # optional: defaults to entire repository

docs/usage.md

@@ -22,7 +22,7 @@ If you want to share your Gosling visualization using the online editor with you
 1. To load a spec you first have to create a gist with a file named gosling.js\* that specifies the spec.
 1. You can additionally specify a `readme.md` file to describe your spec. This will be shown as a side panel on the online editor.
 1. Also, be sure to give your gist a fabulous title. It'll be shown in the gosling editor.
-1. You can then open your visualization at <a>http://<editor_url>/?gist=<github_username>/<gist_id></a>.
+1. You can then open your visualization at `http://<editor_url>/?gist=<github_username>/<gist_id>`.
 
 :::
 Example:

docusaurus.config.js

@@ -1,4 +1,6 @@
 /** @type {import('@docusaurus/types').DocusaurusConfig} */
+const { themes } = require('prism-react-renderer');
+const theme = themes.github;
 module.exports = {
   title: 'Gosling',
   url: 'https://gosling-lang.github.io', // Your website URL
@@ -15,7 +17,7 @@ module.exports = {
   ],
   themeConfig: {
     prism: {
-      theme: require('prism-react-renderer/themes/github'),
+      theme: theme,
     },
     colorMode: {
       defaultMode: 'light',

package.json

@@ -15,19 +15,20 @@
     "tag_version": "docusaurus docs:version"
   },
   "dependencies": {
-    "@docusaurus/core": "2.4.3",
+    "@docusaurus/core": "^3.4.0",
     "@docusaurus/plugin-google-analytics": "2.4.3",
     "@docusaurus/plugin-google-gtag": "2.4.3",
-    "@docusaurus/preset-classic": "2.4.3",
-    "@mdx-js/react": "^1.6.21",
+    "@docusaurus/preset-classic": "^3.4.0",
+    "@mdx-js/react": "^3.0.1",
     "antd": "^4.19.5",
     "clsx": "^1.1.1",
     "gosling-theme": "^0.0.10",
     "gosling.js": "0.8.7",
     "monaco-editor-webpack-plugin": "^4.0.0",
     "pixi.js": "^6.0.4",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
+    "prism-react-renderer": "^2.3.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
     "react-markdown": "^7.0.1",
     "react-monaco-editor": "^0.43.0"
   },

versioned_docs/version-0.10.1.1/getting-started.md

@@ -16,7 +16,7 @@ You can visit [Online Editor](https://gosling.js.org) to visualize your data dir
 1. To load a spec you first have to create a gist with a file named gosling.js* that specifies the spec.
 1. You can additionally specify a readme.md file to describe your spec.
 1. Also be sure to give your gist a fabulous title. It'll be shown in the gosling editor.
-You can then open your visualization at <a>http://<editor_url>/?gist=<github_username>/<gist_id></a>. 
+You can then open your visualization at `http://<editor_url>/?gist=<github_username>/<gist_id`. 
 <!-- For example, https://gosling.js.org/?gist=flekschas/e6e388332814886d4d714efd0e88093b -->
 For example, https://gosling.js.org/?gist=wangqianwen0418/1cc79f00990806f07b379ae6a7c7b7b3
 

versioned_docs/version-0.10.1/getting-started.md

@@ -16,7 +16,7 @@ You can visit [Online Editor](https://gosling.js.org) to visualize your data dir
 1. To load a spec you first have to create a gist with a file named gosling.js* that specifies the spec.
 1. You can additionally specify a readme.md file to describe your spec.
 1. Also be sure to give your gist a fabulous title. It'll be shown in the gosling editor.
-You can then open your visualization at <a>http://<editor_url>/?gist=<github_username>/<gist_id></a>. 
+You can then open your visualization at `http://<editor_url>/?gist=<github_username>/<gist_id>`. 
 <!-- For example, https://gosling.js.org/?gist=flekschas/e6e388332814886d4d714efd0e88093b -->
 For example, https://gosling.js.org/?gist=wangqianwen0418/1cc79f00990806f07b379ae6a7c7b7b3
 

versioned_docs/version-0.11.0/usage.md

@@ -20,7 +20,7 @@ You can visit the [online editor](https://gosling.js.org) to start trying Goslin
 1. To load a spec you first have to create a gist with a file named gosling.js\* that specifies the spec.
 1. You can additionally specify a `readme.md` file to describe your spec.
 1. Also be sure to give your gist a fabulous title. It'll be shown in the gosling editor.
-   You can then open your visualization at <a>http://<editor_url>/?gist=<github_username>/<gist_id></a>.
+   You can then open your visualization at `http://<editor_url>/?gist=<github_username>/<gist_id>`.
    <!-- For example, https://gosling.js.org/?gist=flekschas/e6e388332814886d4d714efd0e88093b -->
    For example, https://gosling.js.org/?gist=wangqianwen0418/1cc79f00990806f07b379ae6a7c7b7b3
 

versioned_docs/version-0.17.0/usage.md

@@ -20,7 +20,7 @@ You can visit the [online editor](https://gosling.js.org) to start trying Goslin
 1. To load a spec you first have to create a gist with a file named gosling.js\* that specifies the spec.
 1. You can additionally specify a `readme.md` file to describe your spec.
 1. Also be sure to give your gist a fabulous title. It'll be shown in the gosling editor.
-   You can then open your visualization at <a>http://<editor_url>/?gist=<github_username>/<gist_id></a>.
+   You can then open your visualization at `http://<editor_url>/?gist=<github_username>/<gist_id>`.
    <!-- For example, https://gosling.js.org/?gist=flekschas/e6e388332814886d4d714efd0e88093b -->
    For example, https://gosling.js.org/?gist=wangqianwen0418/1cc79f00990806f07b379ae6a7c7b7b3
 

versioned_docs/version-0.17.1/usage.md

@@ -20,7 +20,7 @@ You can visit the [online editor](https://gosling.js.org) to start trying Goslin
 1. To load a spec you first have to create a gist with a file named gosling.js\* that specifies the spec.
 1. You can additionally specify a `readme.md` file to describe your spec.
 1. Also be sure to give your gist a fabulous title. It'll be shown in the gosling editor.
-   You can then open your visualization at <a>http://<editor_url>/?gist=<github_username>/<gist_id></a>.
+   You can then open your visualization at `http://<editor_url>/?gist=<github_username>/<gist_id>`.
    <!-- For example, https://gosling.js.org/?gist=flekschas/e6e388332814886d4d714efd0e88093b -->
    For example, https://gosling.js.org/?gist=wangqianwen0418/1cc79f00990806f07b379ae6a7c7b7b3
 

versioned_docs/version-0.9.20/getting-started.md

@@ -16,7 +16,7 @@ You can visit [Online Editor](https://gosling.js.org) to visualize your data dir
 1. To load a spec you first have to create a gist with a file named gosling.js* that specifies the spec.
 1. You can additionally specify a readme.md file to describe your spec.
 1. Also be sure to give your gist a fabulous title. It'll be shown in the gosling editor.
-You can then open your visualization at <a>http://<editor_url>/?gist=<github_username>/<gist_id></a>. 
+You can then open your visualization at `http://[editor_url]/?gist=[github_username]/[gist_id]`. 
 <!-- For example, https://gosling.js.org/?gist=flekschas/e6e388332814886d4d714efd0e88093b -->
 For example, https://gosling.js.org/?gist=wangqianwen0418/1cc79f00990806f07b379ae6a7c7b7b3
 

versioned_docs/version-0.9.30/getting-started.md

@@ -16,7 +16,7 @@ You can visit [Online Editor](https://gosling.js.org) to visualize your data dir
 1. To load a spec you first have to create a gist with a file named gosling.js* that specifies the spec.
 1. You can additionally specify a readme.md file to describe your spec.
 1. Also be sure to give your gist a fabulous title. It'll be shown in the gosling editor.
-You can then open your visualization at <a>http://<editor_url>/?gist=<github_username>/<gist_id></a>. 
+You can then open your visualization at `http://[editor_url]/?gist=[github_username]/[gist_id]`. 
 <!-- For example, https://gosling.js.org/?gist=flekschas/e6e388332814886d4d714efd0e88093b -->
 For example, https://gosling.js.org/?gist=wangqianwen0418/1cc79f00990806f07b379ae6a7c7b7b3
 

versioned_docs/version-0.9/getting-started.md

@@ -16,7 +16,7 @@ You can visit [Online Editor](https://gosling.js.org) to visualize your data dir
 1. To load a spec you first have to create a gist with a file named gosling.js* that specifies the spec.
 1. You can additionally specify a readme.md file to describe your spec.
 1. Also be sure to give your gist a fabulous title. It'll be shown in the gosling editor.
-You can then open your visualization at <a>http://<editor_url>/?gist=<github_username>/<gist_id></a>. 
+You can then open your visualization at `http://<editor_url>/?gist=<github_username>/<gist_id>`. 
 <!-- For example, https://gosling.js.org/?gist=flekschas/e6e388332814886d4d714efd0e88093b -->
 For example, https://gosling.js.org/?gist=wangqianwen0418/1cc79f00990806f07b379ae6a7c7b7b3
 

versioned_sidebars/version-0.10.1-sidebars.json

@@ -1,8 +1,8 @@
 {
-  "version-0.10.1/docs": [
+  "docs": [
     {
       "type": "doc",
-      "id": "version-0.10.1/getting-started"
+      "id": "getting-started"
     },
     {
       "type": "category",
@@ -11,50 +11,50 @@
       "items": [
         {
           "type": "doc",
-          "id": "version-0.10.1/data"
+          "id": "data"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1/genome-builds"
+          "id": "genome-builds"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1/mark"
+          "id": "mark"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1/visual-channel"
+          "id": "visual-channel"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1/composition"
+          "id": "composition"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1/user-interaction"
+          "id": "user-interaction"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1/semantic-zoom"
+          "id": "semantic-zoom"
         }
       ],
       "collapsible": true
     },
     {
       "type": "doc",
-      "id": "version-0.10.1/js-api"
+      "id": "js-api"
     },
     {
       "type": "doc",
-      "id": "version-0.10.1/non-gos-vis"
+      "id": "non-gos-vis"
     },
     {
       "type": "doc",
-      "id": "version-0.10.1/public-datasets"
+      "id": "public-datasets"
     },
     {
       "type": "doc",
-      "id": "version-0.10.1/FAQ"
+      "id": "FAQ"
     }
   ]
 }

versioned_sidebars/version-0.10.1.1-sidebars.json

@@ -1,8 +1,8 @@
 {
-  "version-0.10.1.1/docs": [
+  "docs": [
     {
       "type": "doc",
-      "id": "version-0.10.1.1/getting-started"
+      "id": "getting-started"
     },
     {
       "type": "category",
@@ -11,50 +11,50 @@
       "items": [
         {
           "type": "doc",
-          "id": "version-0.10.1.1/data"
+          "id": "data"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1.1/genome-builds"
+          "id": "genome-builds"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1.1/mark"
+          "id": "mark"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1.1/visual-channel"
+          "id": "visual-channel"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1.1/composition"
+          "id": "composition"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1.1/user-interaction"
+          "id": "user-interaction"
         },
         {
           "type": "doc",
-          "id": "version-0.10.1.1/semantic-zoom"
+          "id": "semantic-zoom"
         }
       ],
       "collapsible": true
     },
     {
       "type": "doc",
-      "id": "version-0.10.1.1/js-api"
+      "id": "js-api"
     },
     {
       "type": "doc",
-      "id": "version-0.10.1.1/non-gos-vis"
+      "id": "non-gos-vis"
     },
     {
       "type": "doc",
-      "id": "version-0.10.1.1/public-datasets"
+      "id": "public-datasets"
     },
     {
       "type": "doc",
-      "id": "version-0.10.1.1/FAQ"
+      "id": "FAQ"
     }
   ]
 }

versioned_sidebars/version-0.9-sidebars.json

@@ -1,8 +1,8 @@
 {
-  "version-0.9/docs": [
+  "docs": [
     {
       "type": "doc",
-      "id": "version-0.9/getting-started"
+      "id": "getting-started"
     },
     {
       "type": "category",
@@ -11,46 +11,46 @@
       "items": [
         {
           "type": "doc",
-          "id": "version-0.9/data"
+          "id": "data"
         },
         {
           "type": "doc",
-          "id": "version-0.9/genome-builds"
+          "id": "genome-builds"
         },
         {
           "type": "doc",
-          "id": "version-0.9/mark"
+          "id": "mark"
         },
         {
           "type": "doc",
-          "id": "version-0.9/visual-channel"
+          "id": "visual-channel"
         },
         {
           "type": "doc",
-          "id": "version-0.9/composition"
+          "id": "composition"
         },
         {
           "type": "doc",
-          "id": "version-0.9/user-interaction"
+          "id": "user-interaction"
         },
         {
           "type": "doc",
-          "id": "version-0.9/semantic-zoom"
+          "id": "semantic-zoom"
         }
       ],
       "collapsible": true
     },
     {
       "type": "doc",
-      "id": "version-0.9/js-api"
+      "id": "js-api"
     },
     {
       "type": "doc",
-      "id": "version-0.9/public-datasets"
+      "id": "public-datasets"
     },
     {
       "type": "doc",
-      "id": "version-0.9/FAQ"
+      "id": "FAQ"
     }
   ]
 }