Merge pull request #9 from New1Direction/ci/deploy-docs-pages

New1Direction · web-flow · commit a2f8e4543b7a · 2026-06-13T08:16:12.000-06:00
ci: deploy docs to GitHub Pages (static export)
diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml
@@ -0,0 +1,58 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - 'website/**'
+      - '.github/workflows/deploy-pages.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# One Pages deployment at a time; don't cancel an in-progress publish.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Enable GitHub Pages (Actions source)
+        uses: actions/configure-pages@v5
+        with:
+          enablement: true
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: website/package-lock.json
+      - name: Install deps
+        working-directory: website
+        run: npm install
+      - name: Build static export
+        working-directory: website
+        env:
+          # Project Pages site is served under /<repo>/.
+          NEXT_PUBLIC_BASE_PATH: /repolens
+        run: npm run build
+      - name: Disable Jekyll (serve _next/ as-is)
+        run: touch website/out/.nojekyll
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: website/out
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/website/app/api/search/route.ts b/website/app/api/search/route.ts
@@ -1,5 +1,8 @@
 import { createFromSource } from 'fumadocs-core/search/server';
 import { source } from '@/lib/source';
 
-// Builds the search index from the docs source (now that lib/source resolves files correctly).
-export const { GET } = createFromSource(source);
+// Static search index so the docs export to plain HTML (`output: export`) for
+// GitHub Pages. The client (app/layout.tsx) is configured for static search.
+export const revalidate = false;
+
+export const { staticGET: GET } = createFromSource(source);
diff --git a/website/app/layout.tsx b/website/app/layout.tsx
@@ -2,6 +2,10 @@ import type { ReactNode } from 'react';
 import { RootProvider } from 'fumadocs-ui/provider';
 import './global.css';
 
+// On GitHub Pages the static export is served under /<repo>/, so the static search
+// index lives at <basePath>/api/search. Empty when served at root (local dev).
+const basePath = process.env.NEXT_PUBLIC_BASE_PATH ?? '';
+
 export const metadata = {
   title: 'RepoLens — read code before you trust it',
   description:
@@ -12,7 +16,9 @@ export default function RootLayout({ children }: { children: ReactNode }) {
   return (
     <html lang="en" suppressHydrationWarning>
       <body>
-        <RootProvider>{children}</RootProvider>
+        <RootProvider search={{ options: { type: 'static', api: `${basePath}/api/search` } }}>
+          {children}
+        </RootProvider>
       </body>
     </html>
   );
diff --git a/website/next.config.mjs b/website/next.config.mjs
@@ -2,9 +2,17 @@ import { createMDX } from 'fumadocs-mdx/next';
 
 const withMDX = createMDX();
 
+// On GitHub Pages a project site is served under /<repo>/, so CI sets
+// NEXT_PUBLIC_BASE_PATH=/repolens. Locally it's unset (served at root).
+const basePath = process.env.NEXT_PUBLIC_BASE_PATH || undefined;
+
 /** @type {import('next').NextConfig} */
 const config = {
   reactStrictMode: true,
+  output: 'export',            // static HTML export — hostable on GitHub Pages / any static host
+  images: { unoptimized: true }, // required by `output: export`
+  basePath,
+  trailingSlash: false,        // rely on GitHub Pages serving `foo.html` for `/foo`
 };
 
 export default withMDX(config);
