Updated docs

Author: chandr-andr

.github/workflows/deploy-docs.yml

@@ -0,0 +1,50 @@
+
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - support_dbapi
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          # if your docs needs submodules, uncomment the following line
+          # submodules: true
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: pnpm
+
+      - name: Install Deps
+        run: |
+          corepack enable
+          pnpm install --frozen-lockfile
+
+      - name: Build Docs
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          pnpm run docs:build
+          > docs/.vuepress/dist/.nojekyll
+
+      - name: Deploy Docs
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          # Deploy Docs
+          branch: gh-pages
+          folder: docs/.vuepress/dist

.gitignore

@@ -77,4 +77,8 @@ _load_test
 
 # JS
 node_modules
-.temp
+.temp
+node_modules/
+docs/.vuepress/.cache/
+docs/.vuepress/.temp/
+docs/.vuepress/dist/

docs/.vuepress/config.ts

@@ -1,15 +1,14 @@
 import { defineUserConfig } from "vuepress";
 import { hopeTheme } from "vuepress-theme-hope";
 import sidebar from "./sidebar.js";
-
-import { viteBundler } from '@vuepress/bundler-vite'
+import { markdownTabPlugin } from '@vuepress/plugin-markdown-tab'
 
 export default defineUserConfig({
   lang: "en-US",
   title: "PSQLPy",
   description: "PSQLPy Documentation",
 
-  bundler: viteBundler(),
+  // bundler: viteBundler(),
 
   theme: hopeTheme({
     repo: "psqlpy-python/psqlpy",
@@ -22,22 +21,20 @@ export default defineUserConfig({
 
     hostname: "https://psqlpy-python.github.io/",
 
+    markdown: {
+      tabs: true,
+      mermaid: true,
+      chartjs: true,
+    },
+
     plugins: {
       readingTime: false,
-
       copyCode: {
         showInMobile: true,
       },
 
-      searchPro: {
+      slimsearch: {
         indexContent: true,
-        autoSuggestions: false,
-      },
-
-      mdEnhance: {
-        tabs: true,
-        mermaid: true,
-        chart: true,
       },
 
       sitemap: {

docs/.vuepress/sidebar.ts

@@ -23,6 +23,7 @@ export default sidebar({
         "connection",
         "transaction",
         "cursor",
+        "prepared_statement",
         "listener",
         "results",
         "exceptions",

docs/.vuepress/styles/config.scss

@@ -0,0 +1,3 @@
+$code-dark-theme: dracula;
+$code-light-theme: one-light;
+$theme-color: #264934;

docs/.vuepress/styles/index.scss

@@ -0,0 +1,19 @@
+// place your custom styles here
+.vp-site-name {
+    visibility: hidden;
+}
+
+.vp-hero-info {
+    img {
+        max-width: 60% !important;
+        padding: 1rem;
+    }
+}
+
+.vp-hero-title {
+  font-size: 3rem;
+}
+
+.vp-actions {
+    align-items: flex-end;
+}

docs/.vuepress/styles/palette.scss

@@ -0,0 +1 @@
+// you can change colors here