ci: adds initial CI/CD pipeline for preview

Author: claymcleod

Diff for: .github/workflows/deploy-preview.yml

@@ -0,0 +1,41 @@
+name: Deploy a Preview Site
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "latest"
+      - run: npm install -g pnpm
+      - run: pnpm install
+      - run: sed -i "s|<name>|${GITHUB_HEAD_REF}|g" nuxt.config.ts
+      - run: pnpm run generate
+      - run: |
+          mkdir -p dist/branches/${{ github.head_ref }}
+          mv .output/public/* dist/branches/${{ github.head_ref }} || exit 0
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          name: "Project Documentation - Branch (${{ github.head_ref }})"
+          path: "dist"
+  deploy:
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          artifact_name: "Project Documentation - Branch (${{ github.head_ref }})"

Diff for: nuxt.config.ts

@@ -5,6 +5,8 @@ export default defineNuxtConfig({
   compatibilityDate: "2024-04-03",
   css: ["~/assets/css/main.postcss"],
   devtools: { enabled: true },
+  ssr: false,
+  rootDir: "/docs",
   modules: [
     "nuxt-lucide-icons",
     "@nuxt/content",
@@ -26,4 +28,4 @@ export default defineNuxtConfig({
       linkExactActiveClass: "active",
     },
   },
-});
+});