Merge pull request #1 from nxtgrid/chore/add-github-pages-deploy

build for github pages

Author: bobbybol

.github/workflows/deploy-pages.yml

@@ -0,0 +1,56 @@
+name: Deploy docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      DOCS_DEPLOY_TARGET: gh-pages
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build site
+        run: npm run build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./build
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docusaurus.config.ts

@@ -4,6 +4,15 @@ import type * as Preset from '@docusaurus/preset-classic';
 
 // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
 
+const deployTarget = process.env.DOCS_DEPLOY_TARGET ?? 'netlify';
+
+const siteUrl =
+  deployTarget === 'gh-pages'
+    ? 'https://nxtgrid.github.io'
+    : 'https://docs.nxtgrid.co';
+
+const siteBaseUrl = deployTarget === 'gh-pages' ? '/nxt-docs/' : '/';
+
 const config: Config = {
   title: 'NXT Docs',
   tagline: 'Unified documentation for NXT open-source software',
@@ -15,10 +24,10 @@ const config: Config = {
   },
 
   // Set the production url of your site here
-  url: 'https://docs.nxtgrid.co',
+  url: siteUrl,
   // Set the /<baseUrl>/ pathname under which your site is served
   // For Netlify/custom domain root hosting, keep this as '/'
-  baseUrl: '/',
+  baseUrl: siteBaseUrl,
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.