Configure GitHub Pages deployment and update Nuxt settings for improved documentation generation

Author: ManukMinasyan

.github/workflows/deploy-docs.yml

@@ -0,0 +1,73 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["2.x"]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/deploy-docs.yml'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: 'docs/package.json'
+      
+      - name: Install dependencies
+        working-directory: ./docs
+        run: npm ci
+      
+      - name: Build documentation
+        working-directory: ./docs
+        run: npm run generate
+        env:
+          NUXT_APP_BASE_URL: /flowforge/
+      
+      - name: Add .nojekyll file
+        working-directory: ./docs
+        run: touch .output/public/.nojekyll
+      
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/.output/public
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/nuxt.config.ts

@@ -3,6 +3,9 @@ export default defineNuxtConfig({
     extends: 'docus',
     modules: ["@nuxt/image", "@nuxt/scripts"],
     devtools: {enabled: true},
+    app: {
+        baseURL: process.env.NODE_ENV === 'production' ? '/flowforge/' : '/'
+    },
     content: {
         build: {
             markdown: {
@@ -13,5 +16,8 @@ export default defineNuxtConfig({
                 }
             }
         }
+    },
+    nitro: {
+        preset: 'github_pages'
     }
-})
+})

docs/package.json

@@ -1,17 +1,19 @@
 {
-  "name": "flowforge-docs",
-  "scripts": {
-    "dev": "nuxt dev --extends docus",
-    "build": "nuxt build --extends docus"
-  },
-  "dependencies": {
-    "@nuxt/image": "^1.11.0",
-    "@nuxt/scripts": "^0.11.13",
-    "@nuxt/ui": "^3.3.3",
-    "@unhead/vue": "^2.0.14",
-    "better-sqlite3": "^12.2.0",
-    "docus": "latest",
-    "nuxt": "^4.1.0",
-    "typescript": "^5.9.2"
-  }
+    "name": "flowforge-docs",
+    "scripts": {
+        "dev": "nuxt dev --extends docus",
+        "build": "nuxt build --extends docus",
+        "generate": "nuxt build --preset github_pages",
+        "preview": "nuxt preview"
+    },
+    "dependencies": {
+        "@nuxt/image": "^1.11.0",
+        "@nuxt/scripts": "^0.11.13",
+        "@nuxt/ui": "^3.3.3",
+        "@unhead/vue": "^2.0.14",
+        "better-sqlite3": "^12.2.0",
+        "docus": "latest",
+        "nuxt": "^4.1.0",
+        "typescript": "^5.9.2"
+    }
 }