add nextra documentation website

Author: Sagar Velankar

.github/workflows/cicd_pipeline.yml

@@ -0,0 +1,80 @@
+name: CI/CD pipeline
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ['release/1.0']
+
+  # 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-documentation:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          package_json_file: docs/package.json
+          run_install: false
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'pnpm'
+          cache-dependency-path: docs/pnpm-lock.yaml
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+        with:
+          static_site_generator: next
+
+      - name: Restore cache
+        uses: actions/cache@v4
+        with:
+          path: ./docs/.next/cache
+          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.yaml') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
+          restore-keys: |
+            ${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.yaml') }}-
+
+      - name: Install dependencies
+        run: cd "${{ github.workspace }}/docs" && pnpm install
+
+      - name: Build with Next.js
+        run: cd "${{ github.workspace }}/docs" && pnpm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/out
+
+  # Deployment job
+  deploy-documentation:
+    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

.vscode/tasks.json

@@ -19,7 +19,30 @@
       "label": "Run with opentelemetry",
       "problemMatcher": [],
       "type": "shell"
-    }
+    },
+    {
+      "command": "pnpm dev",
+      "group": {
+        "isDefault": true,
+        "kind": "build"
+      },
+      "label": "Start documentation website in development mode",
+      "options": {
+        "cwd": "docs"
+      },
+      "type": "shell"
+    },
+    {
+      "command": "pnpm i",
+      "group": {
+        "kind": "build"
+      },
+      "label": "Install dependencies for documentation website",
+      "options": {
+        "cwd": "docs"
+      },
+      "type": "shell"
+    },
   ],
   "version": "2.0.0"
 }

README.md

@@ -0,0 +1 @@
+docs/pages/docs/index.mdx

docs/.gitignore

@@ -0,0 +1,38 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/tasks.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+/node_modules/
+/lib/
+/test/
+custom-elements.json
+/bin/
+/internal/
+/src/annotative/highlight.js
+/src/annotative/styles/css
+/src/annotative/constants/*.json
+
+/.next/
+/out/

docs/.gitkeep

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

docs/next-env.d.ts

@@ -0,0 +1,27 @@
+import nextra from 'nextra'
+
+const withNextra = nextra({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.tsx',
+  latex: true,
+  flexsearch: {
+    codeblocks: false
+  },
+  defaultShowCopyCode: true
+});
+
+export default withNextra({
+  basePath: '/devops-cicd-pipeline-code-generator',
+  output: 'export',
+  images: {
+    unoptimized: true,
+  },
+  reactStrictMode: true,
+  redirects: () => [
+    {
+      source: '/',
+      destination: '/docs',
+      permanent: true
+    }
+  ]
+})

docs/next.config.mjs

@@ -0,0 +1,35 @@
+{
+  "name": "devops-cicd-pipeline-code-generator",
+  "version": "1.0.0",
+  "description": "DevOps CI/CD pipeline code generator",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/devopscodegen/devops-cicd-pipeline-code-generator.git"
+  },
+  "author": "Sagar Velankar <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/devopscodegen/devops-cicd-pipeline-code-generator/issues"
+  },
+  "homepage": "https://devopscodegen.github.io/devops-cicd-pipeline-code-generator",
+  "dependencies": {
+    "@next/third-parties": "14",
+    "next": "^14",
+    "nextra": "^2",
+    "nextra-theme-docs": "^2",
+    "react": "^18",
+    "react-dom": "^18"
+  },
+  "devDependencies": {
+    "@types/node": "^22",
+    "typescript": "^5",
+    "postcss": "^8",
+    "tailwindcss": "^3",
+    "autoprefixer": "^10"
+  }
+}

docs/package.json

@@ -0,0 +1,5 @@
+import { NotFoundPage } from 'nextra-theme-docs'
+
+# 404: Page Not Found
+
+<NotFoundPage />

docs/pages/404.mdx

@@ -0,0 +1,11 @@
+import { GoogleAnalytics } from '@next/third-parties/google';
+import '../style.css';
+
+export default function MyApp({ Component, pageProps }) {
+  return (
+    <>
+      <Component {...pageProps} />
+      <GoogleAnalytics gaId="GTM-NF267TL6" />
+    </>
+  );
+}