Merge pull request #2644 from doc4d/gk/router

Add static build

.github/workflows/build.yml

@@ -9,10 +9,12 @@ on:
       - '!main'
 
 jobs:
-  workflow-check:
+  check:
     uses: ./.github/workflows/workflow-syntax-check.yml
-  workflow-build:
+  build:
     uses: ./.github/workflows/workflow-build.yml
     concurrency:
-      group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-      cancel-in-progress:  true
+      group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}-build
+      cancel-in-progress:  true
+  build-static:
+    uses: ./.github/workflows/workflow-build-static.yml

.github/workflows/deploy.yml

@@ -9,6 +9,8 @@ jobs:
     uses: ./.github/workflows/workflow-syntax-check.yml
   workflow-build:
     uses: ./.github/workflows/workflow-build.yml
+  workflow-static:
+    uses: ./.github/workflows/workflow-build-static.yml
 
   gh-release:
     needs: [workflow-build]
@@ -22,3 +24,21 @@ jobs:
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         publish_dir: ./build/
+
+  publish-release:
+    needs: [workflow-static]
+    name: 'Publish Release'
+    runs-on: ubuntu-latest
+    steps:
+    - name: Download artifact
+      uses: actions/download-artifact@v4
+      with:
+        pattern: static-doc-*
+    - name: Upload Release Asset
+      uses: softprops/action-gh-release@v2
+      with:
+        files: |
+          static-doc-*
+        token: ${{ secrets.GITHUB_TOKEN }}
+        prerelease: true
+

.github/workflows/workflow-build-static.yml

@@ -0,0 +1,31 @@
+name: Build static documentation
+
+on:
+  workflow_call:
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        language: ["en", "fr", "es", "ja", "pt"]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '22.x'
+      - name: Build
+        run: |
+          if [ -e package-lock.json ]; then
+          npm ci
+          else
+          npm i
+          fi
+          npm run build -- --locale ${{ matrix.language }}
+        env:
+            DOCUSAURUS_LANGUAGE: ${{ matrix.language }}
+            DOCUSAURUS_ROUTER: 'hash'
+      - uses: actions/upload-artifact@v4
+        with:
+          path: ./build
+          name: static-doc-${{ matrix.language }}

.github/workflows/workflow-build.yml

@@ -28,7 +28,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: '20.x'
+          node-version: '22.x'
       - name: Build
         run: |
           if [ -e package-lock.json ]; then

.github/workflows/workflow-syntax-check.yml

@@ -15,7 +15,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: '20.x'
+          node-version: '22.x'
       - name: Diff images
         env:
           CLICOLOR_FORCE: 1

docusaurus.config.js

@@ -5,11 +5,33 @@ const darkTheme = themes.palenight;
 
 
 const isProduction = process.env.GITHUB_REPOSITORY_OWNER === '4d';
+const router = process.env.DOCUSAURUS_ROUTER
+const isStatic = process.env.DOCUSAURUS_ROUTER === "hash"
+const language = process.env.DOCUSAURUS_LANGUAGE ?? "en"
+
+const locales = isStatic ? [language] : ["en", "fr", "es", "ja", "pt"]
+const localeConfigs = isStatic ? {} : {
+  en: {
+    label: "English",
+  },
+  fr: {
+    label: "Français",
+  },
+  es: {
+    label: "Español",
+  },
+  ja: {
+    label: "日本語",
+  },
+  pt: {
+    label: "Português",
+  },
+}
 
 module.exports = {
   title: "4D Docs",
   tagline: "Documentation for 4D developers",
-  baseUrl: "/docs/",
+  baseUrl: isStatic ? "/" : "/docs/",
   //url: "https://4d.github.io/",
   url: "https://developer.4d.com/",
   organizationName: "4D",
@@ -79,27 +101,12 @@ module.exports = {
       rspackBundler: true,
       mdxCrossCompilerCache: true,
     },
+    experimental_router: router,
   },
   i18n: {
-    defaultLocale: "en",
-    locales: ["en", "fr", "es", "ja", "pt"],
-    localeConfigs: {
-      en: {
-        label: "English",
-      },
-      fr: {
-        label: "Français",
-      },
-      es: {
-        label: "Español",
-      },
-      ja: {
-        label: "日本語",
-      },
-      pt: {
-        label: "Português",
-      },
-    },
+    defaultLocale: language,
+    locales: locales,
+    localeConfigs: localeConfigs,
   },
   plugins: [
     [
@@ -250,5 +257,5 @@ module.exports = {
       maintainCase: false,
     },
   },
- themes: ['@docusaurus/theme-mermaid'],
+  themes: ['@docusaurus/theme-mermaid'],
 }