Typescript Migration and Adjustments

.github/workflows/documentation.yml

@@ -2,15 +2,18 @@ name: documentation
 on:
   push:
     branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
 jobs:
   checks:
     if: github.event_name != 'push'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: '16.x'
+          node-version: '20.x'
       - name: Test Build
         run: |
           cd eigr_io
@@ -26,10 +29,10 @@ jobs:
     if: github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: '16.x'
+          node-version: '20.x'
       - name: Release to GitHub Pages
         env:
           USE_SSH: false

eigr_io/docusaurus.config.js → eigr_io/docusaurus.config.ts

@@ -1,8 +1,8 @@
-const lightCodeTheme = require('prism-react-renderer/themes/github');
-const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+import {themes as prismThemes} from 'prism-react-renderer';
+import type {Config} from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
 
-/** @type {import('@docusaurus/types').DocusaurusConfig} */
-module.exports = {
+const config: Config = {
     title: 'eigr.io',
     tagline: 'A Serverless Runtime on the BEAM',
     url: 'https://eigr.io',
@@ -89,17 +89,17 @@ module.exports = {
             copyright: `Copyright © ${new Date().getFullYear()} – eigr.io | graphics design by <a href="https://ursulahitz.com">ursulahitz.com</a>`,
         },
         prism: {
-            theme: lightCodeTheme,
-            darkTheme: darkCodeTheme,
+            theme: prismThemes.github,
+            darkTheme: prismThemes.dracula,
             additionalLanguages: ['elixir', 'java', 'protobuf'],
         },
-    },
+    } satisfies Preset.ThemeConfig,
     presets: [
         [
             '@docusaurus/preset-classic',
             {
                 docs: {
-                    sidebarPath: require.resolve('./sidebars.js'),
+                    sidebarPath: require.resolve('./sidebars.ts'),
                     // Please change this to your repo.
                     editUrl:
                         'https://github.com/eigr/eigr.github.io/edit/main/website/',
@@ -113,7 +113,7 @@ module.exports = {
                 theme: {
                     customCss: require.resolve('./src/css/custom.css'),
                 },
-            },
+            } satisfies Preset.Options,
         ],
         [
             'docusaurus-protobuffet',
@@ -131,3 +131,5 @@ module.exports = {
         ],
     ],
 };
+
+export default config;

eigr_io/package.json

@@ -14,17 +14,15 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.1.0",
-    "@docusaurus/preset-classic": "^2.1.0",
-    "@mdx-js/react": "^1.6.21",
-    "@svgr/webpack": "^5.5.0",
-    "clsx": "^1.1.1",
-    "docusaurus-protobuffet": "^0.3.2",
-    "file-loader": "^6.2.0",
-    "prism-react-renderer": "^1.2.1",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
-    "url-loader": "^4.1.1"
+    "@docusaurus/core": "^3.0.1",
+    "@docusaurus/preset-classic": "^3.0.1",
+    "@mdx-js/react": "^3.0.0",
+    "@svgr/webpack": "^8.1.0",
+    "clsx": "^2.0.0",
+    "docusaurus-protobuffet": "^0.3.3",
+    "prism-react-renderer": "^2.3.0",
+    "react": "^18.0.2",
+    "react-dom": "^18.0.2"
   },
   "browserslist": {
     "production": [
@@ -37,5 +35,11 @@
       "last 1 firefox version",
       "last 1 safari version"
     ]
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "^3.0.1",
+    "@docusaurus/tsconfig": "^3.0.1",
+    "@docusaurus/types": "^3.0.1",
+    "typescript": "^5.3.3"
   }
 }

eigr_io/sidebars.js → eigr_io/sidebars.ts

@@ -1,3 +1,5 @@
+import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+
 /**
  * Creating a sidebar enables you to:
  - create an ordered group of docs
@@ -8,19 +10,22 @@
 
  Create as many sidebars as you want.
  */
-
-module.exports = {
+const eigrSidebar: SidebarsConfig = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
   eigrSidebar: [{type: 'autogenerated', dirName: '.'}],
 
   // But you can create a sidebar manually
   /*
   tutorialSidebar: [
+    'intro',
+    'hello',
     {
       type: 'category',
-      label: 'Documentation',
-      items: ['hello'],
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
     },
   ],
    */
 };
+
+export default eigrSidebar;

eigr_io/src/css/custom.css

@@ -14,8 +14,8 @@
     --ifm-color-primary-light: #fe1a7b;
     --ifm-color-primary-lighter: #fe2782;
     --ifm-color-primary-lightest: #fe4d98;
-    --ifm-code-font-size: 85%;
-    --ifm-font-size-base: 80%;
+    --ifm-code-font-size: 90%;
+    --ifm-font-size-base: 95%;
 }
 
 .docusaurus-highlight-code-line {

eigr_io/src/pages/index.js → eigr_io/src/pages/index.tsx

@@ -19,7 +19,7 @@ function HomepageHeader() {
                     <Link
                         className="button button--secondary button--lg"
                         to="https://eigr.io/docs/projects-spawn/spawn-introduction/">
-                        Get Started with Spawn"
+                        Get Started with Spawn
                     </Link>
                 </div>
             </div>

eigr_io/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  // This file is not used in compilation. It is here just for a nice editor experience.
+  "extends": "@docusaurus/tsconfig",
+  "compilerOptions": {
+    "baseUrl": "."
+  }
+}