converted docs to vitepress

.github/workflows/deploy.yml

@@ -0,0 +1,66 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+
+  # 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:
+    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
+          cache: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: |
+          npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+          touch docs/.vitepress/dist/.nojekyll
+      - 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

.gitignore

@@ -10,4 +10,6 @@ logs
 dist
 **/node_modules
 *.zip
-ving/drizzle/migrations
+ving/drizzle/migrations
+docs/.vitepress/cache
+docs/.vitepress/dist

docs/.vitepress/config.js

@@ -0,0 +1,66 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Ving",
+  base: '/repo/',
+  description: "An opinionated Nuxt starter with restful API included",
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Documentation', link: '/installation' }
+    ],
+
+    sidebar: [
+      {
+        text: 'Examples',
+        items: [
+          { text: 'Markdown Examples', link: '/markdown-examples' },
+          { text: 'Runtime API Examples', link: '/api-examples' }
+        ]
+      },
+      {
+        text: 'Basics',
+        items: [
+          { text: 'Installation', link: '/installation' },
+          { text: 'Environment Variables', link: '/env' },
+          { text: 'Error Codes', link: '/error-codes' },
+          { text: 'Change Log', link: '/change-log' },
+        ]
+      },
+      {
+        text: 'Subsystems',
+        items: [
+          { text: 'Cache', link: '/subsystems/cache' },
+          { text: 'CLI', link: '/subsystems/cli' },
+          { text: 'Drizzle', link: '/subsystems/drizzle' },
+          { text: 'Email', link: '/subsystems/email' },
+          { text: 'Jobs', link: '/subsystems/jobs' },
+          { text: 'Logging', link: '/subsystems/logging' },
+          { text: 'Message Bus', link: '/subsystems/messagebus' },
+          { text: 'Pulumi', link: '/subsystems/pulumi' },
+          { text: 'Rest', link: '/subsystems/rest' },
+          { text: 'UI', link: '/subsystems/ui' },
+          { text: 'Utilities', link: '/subsystems/utils' },
+          { text: 'Ving Record', link: '/subsystems/ving-record' },
+          { text: 'Ving Schema', link: '/subsystems/ving-schema' },
+        ]
+      },
+      {
+        text: 'Rest APIs',
+        items: [
+          { text: 'APIKey', link: '/rest/APIKey' },
+          { text: 'S3File', link: '/rest/S3File' },
+          { text: 'Session', link: '/rest/Session' },
+          { text: 'Test', link: '/rest/Test' },
+          { text: 'User', link: '/rest/User' },
+        ]
+      },
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/plainblack/ving' }
+    ]
+  }
+})