Create py.yml workflow file

.github/workflows/deploy.yml

@@ -4,7 +4,37 @@ on:
       - main
 
 jobs:
+  docs:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: "true"
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - name: yarn install
+        working-directory: math-blocks
+        run: yarn install
+      - name: yarn build-tsc
+        working-directory: math-blocks
+        run: yarn build-tsc
+      - name: yarn typedoc
+        working-directory: math-blocks
+        run: yarn typedoc
+      - name: Upload Docs artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: ./docs/
+          name: docs
+
   build:
+    needs: docs
+    permissions:
+      actions: read # to access artifacts from the build job
     runs-on: ubuntu-latest
     env:
       CI: true
@@ -34,8 +64,13 @@ jobs:
         run: yarn install --frozen-lockfile
       - name: yarn build
         run: yarn build
+      - name: download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+          path: ./dist/docs
       - name: Upload Page Artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@v4
         with:
           path: ./dist/
 

.github/workflows/pr.yml

@@ -0,0 +1,92 @@
+name: Node CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - name: Get yarn cache
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v4
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Cache node modules
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: ${{ runner.OS }}-build-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.OS }}-node_modules-
+      - name: yarn install
+        run: yarn install
+      - name: lint
+        run: yarn lint
+
+  build:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - name: Get yarn cache
+        id: yarn-cache
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v4
+        with:
+          path: ${{ steps.yarn-cache.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Cache node modules
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: ${{ runner.OS }}-build-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.OS }}-node_modules-
+      - name: yarn install
+        run: yarn install
+      - name: yarn build
+        run: yarn build
+
+  docs:
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: "true"
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - name: yarn install
+        working-directory: math-blocks
+        run: yarn install
+      - name: yarn build-tsc
+        working-directory: math-blocks
+        run: yarn build-tsc
+      - name: yarn typedoc
+        working-directory: math-blocks
+        run: yarn typedoc

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 dist
+.buildcache
 .vscode
 .DS_Store
 .vite

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "math-blocks"]
+	path = math-blocks
+	url = [email protected]:math-blocks/math-blocks.git

eslint.config.js

@@ -1,28 +1,28 @@
-import js from '@eslint/js'
-import globals from 'globals'
-import reactHooks from 'eslint-plugin-react-hooks'
-import reactRefresh from 'eslint-plugin-react-refresh'
-import tseslint from 'typescript-eslint'
+import js from "@eslint/js";
+import globals from "globals";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+import tseslint from "typescript-eslint";
 
 export default tseslint.config(
-  { ignores: ['dist'] },
+  { ignores: ["dist", "math-blocks"] },
   {
     extends: [js.configs.recommended, ...tseslint.configs.recommended],
-    files: ['**/*.{ts,tsx}'],
+    files: ["**/*.{ts,tsx}"],
     languageOptions: {
       ecmaVersion: 2020,
       globals: globals.browser,
     },
     plugins: {
-      'react-hooks': reactHooks,
-      'react-refresh': reactRefresh,
+      "react-hooks": reactHooks,
+      "react-refresh": reactRefresh,
     },
     rules: {
       ...reactHooks.configs.recommended.rules,
-      'react-refresh/only-export-components': [
-        'warn',
+      "react-refresh/only-export-components": [
+        "warn",
         { allowConstantExport: true },
       ],
     },
-  },
-)
+  }
+);

src/homepage.tsx

@@ -0,0 +1,25 @@
+import { Link } from "react-router-dom";
+
+const Homepage = () => {
+  return (
+    <div>
+      <h1>MathBlocks Demos</h1>
+      <ul>
+        <li>
+          <Link to="/baseline">Baseline</Link>
+        </li>
+        <li>
+          <Link to="/editor">Editor</Link>
+        </li>
+        <li>
+          <Link to="/parser">Parser</Link>
+        </li>
+        <li>
+          <Link to="/solver">Solver</Link>
+        </li>
+      </ul>
+    </div>
+  );
+};
+
+export default Homepage;

src/index.tsx

@@ -1,5 +1,8 @@
 import { createRoot } from "react-dom/client";
-import { createHashRouter, RouterProvider, Link } from "react-router-dom";
+import { createHashRouter, RouterProvider } from "react-router-dom";
+
+import Homepage from "./homepage";
+import NotFound from "./not-found";
 
 import BaselinePage from "./baseline/baseline-page";
 import EditorPage from "./editor/editor-page";
@@ -12,36 +15,6 @@ if (document.body) {
   document.body.appendChild(container);
 }
 
-const Homepage = () => {
-  return (
-    <div>
-      <h1>MathBlocks Demos</h1>
-      <ul>
-        <li>
-          <Link to="/baseline">Baseline</Link>
-        </li>
-        <li>
-          <Link to="/editor">Editor</Link>
-        </li>
-        <li>
-          <Link to="/parser">Parser</Link>
-        </li>
-        <li>
-          <Link to="/solver">Solver</Link>
-        </li>
-      </ul>
-    </div>
-  );
-};
-
-const NotFound = () => {
-  return (
-    <div>
-      <h1>404: Not Found</h1>
-    </div>
-  );
-};
-
 const router = createHashRouter([
   {
     path: "/",

src/not-found.tsx

@@ -0,0 +1,9 @@
+const NotFound = () => {
+  return (
+    <div>
+      <h1>404: Not Found</h1>
+    </div>
+  );
+};
+
+export default NotFound;