docs: refactor docs to use VitePress

.github/workflows/docs.yml

@@ -0,0 +1,65 @@
+name: Deploy GitHub Pages
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+      - 'package.json'
+    branches:
+      - "main"
+
+# 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
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+      - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
+      # - uses: oven-sh/setup-bun@v1 # Uncomment this if you're using Bun
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Build with VitePress
+        run: pnpm run docs:build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/.vitepress/dist/
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.vitepress/config.mts

@@ -0,0 +1,186 @@
+import {DefaultTheme, defineConfig} from 'vitepress'
+
+const repository = "https://github.com/salsita/node-pg-migrate"
+const pkg = require('../../package.json')
+export default defineConfig({
+  title: "Node PG Migrate",
+  description: "Postgresql database migration management tool",
+  base: '/node-pg-migrate/', // for GitHub Pages
+  srcDir: 'src',
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: navBarItems(),
+
+    sidebar: [
+      {
+        base: '/',
+        text: 'Reference',
+        collapsed: false,
+        items: sidebarReference()
+      },
+      {
+        base: '/migrations/',
+        text: 'Defining Migrations',
+        link: '/',
+        collapsed: false,
+        items: sidebarMigrations()
+      },
+      {
+        base: '/faq/',
+        text: 'FAQ',
+        collapsed: false,
+        items: sidebarFAQ()
+      }
+    ],
+
+    search: {
+      provider: 'local',
+    },
+
+    socialLinks: [
+      {icon: 'github', link: repository}
+    ],
+
+    editLink: {
+      pattern: repository + '/edit/main/docs/src/:path',
+      text: 'Edit this page on GitHub'
+    },
+
+  }
+})
+
+function navBarItems(): DefaultTheme.NavItem[] {
+  return [
+    {text: 'Home', link: '/'},
+    {text: 'Getting Started', link: '/getting-started'},
+    {
+      text: 'Migrations',
+      link: '/migrations/',
+      activeMatch: `^/migrations/`
+    },
+    {
+      text: pkg.version,
+      items: [
+        {text: 'Changelog', link: repository + '/blob/main/CHANGELOG.md'},
+        {text: 'Releases', link: repository + '/releases'},
+        {text: 'License', link: repository + '/blob/main/LICENSE'},
+      ]
+    },
+  ]
+}
+
+
+function sidebarReference(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: 'Introduction',
+      link: 'introduction'
+    },
+    {
+      text: 'Getting Started',
+      link: 'getting-started'
+    },
+    {
+      text: 'CLI',
+      link: 'cli'
+    },
+    {
+      text: 'Programmatic API',
+      link: 'api'
+    },
+  ]
+}
+
+function sidebarFAQ(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      text: 'Transpiling Migrations',
+      link: 'transpiling'
+    },
+    {
+      text: 'Troubleshooting',
+      link: 'troubleshooting'
+    }
+  ]
+}
+
+function sidebarMigrations(): DefaultTheme.SidebarItem[] {
+  return [
+    {
+      "text": "Tables",
+      "link": "tables"
+    },
+    {
+      "text": "Columns",
+      "link": "columns"
+    },
+    {
+      "text": "Constraints",
+      "link": "constraints"
+    },
+    {
+      "text": "Indexes",
+      "link": "indexes"
+    },
+    {
+      "text": "Functions",
+      "link": "functions"
+    },
+    {
+      "text": "Triggers",
+      "link": "triggers"
+    },
+    {
+      "text": "Schemas",
+      "link": "schemas"
+    },
+    {
+      "text": "Sequences",
+      "link": "sequences"
+    },
+    {
+      "text": "Views",
+      "link": "views"
+    },
+    {
+      "text": "Materialized Views",
+      "link": "mViews"
+    },
+    {
+      "text": "Types",
+      "link": "types"
+    },
+    {
+      "text": "Domains",
+      "link": "domains"
+    },
+    {
+      "text": "Operators",
+      "link": "operators"
+    },
+    {
+      "text": "Roles",
+      "link": "roles"
+    },
+    {
+      "text": "Policies",
+      "link": "policies"
+    },
+    {
+      "text": "Extensions",
+      "link": "extensions"
+    },
+    {
+      "text": "Grants",
+      "link": "grants"
+    },
+    {
+      "text": "Casts",
+      "link": "casts"
+    },
+    {
+      "text": "Miscellaneous",
+      "link": "misc"
+    }
+  ]
+}

docs/.vitepress/theme/index.ts

@@ -0,0 +1,17 @@
+// https://vitepress.dev/guide/custom-theme
+import { h } from 'vue'
+import type { Theme } from 'vitepress'
+import DefaultTheme from 'vitepress/theme'
+import './style.css'
+
+export default {
+  extends: DefaultTheme,
+  Layout: () => {
+    return h(DefaultTheme.Layout, null, {
+      // https://vitepress.dev/guide/extending-default-theme#layout-slots
+    })
+  },
+  enhanceApp({ app, router, siteData }) {
+    // ...
+  }
+} satisfies Theme