V3 docs

.github/workflows/v3-docs.yml

@@ -0,0 +1,67 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  push:
+    branches: [v3]
+  pull_request:
+    branches: [v3]
+
+  # 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@v3 # 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: yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: yarn install
+      - name: Build with VitePress
+        run: yarn docs:deploy
+      - 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/download-artifact@v4
+        with:
+          path: $GITHUB_WORKSPACE/v3
+      - run: echo $GITHUB_WORKSPACE

.gitignore

@@ -27,3 +27,6 @@ lerna-debug.log*
 
 # Turbo
 .turbo
+
+# VitePress
+**/.vitepress/cache

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "grammarly.selectors": [
+        {
+            "language": "markdown",
+            "scheme": "file"
+        }
+    ]
+}

docs/.vitepress/config.mts

@@ -0,0 +1,61 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "Ovee.js",
+  description: "Simple fully reactive framework for server-side generated markup",
+
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: 'Guide', link: '/guide/installation' },
+      { text: 'API', link: '/api' }
+    ],
+
+    sidebar: {
+      '/guide/': [
+        {
+          text: 'Getting Started',
+          base: '/guide',
+          items: [
+            { text: 'Installation', link: '/installation' },
+            { text: 'Overview', link: '/overview' }
+          ]
+        },
+        {
+          text: 'Usage',
+          base: '/guide/usage',
+          items: [
+            { text: 'App', link: '/app' },
+            { text: 'Modules', link: '/modules' },
+            { text: 'Components', link: '/components' },
+            { text: 'Event Handling', link: '/event-handling' },
+            { text: 'Reactivity', link: '/reactivity' },
+            { text: 'Composables', link: '/composables' },
+            { text: 'JSX', link: '/jsx' },
+          ]
+        },
+        {
+          text: 'Built-in',
+          base: '/guide/built-in',
+          items: [
+            { text: 'useAttribute', link: '/use-attribute' },
+            { text: 'useDataAttr', link: '/use-data-attr' },
+            { text: 'useElementRef', link: '/use-element-ref' },
+            { text: 'useModule', link: '/use-module' },
+            { text: 'useProp', link: '/use-prop' },
+            { text: 'useQueryComponent', link: '/use-query-component' },
+            { text: 'useQuerySelector', link: '/use-query-selector' },
+            { text: 'useSlots', link: '/use-slots' },
+            { text: 'useTemplate', link: '/use-template' },
+          ]
+        }
+      ],
+      '/api/': [],
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/vuejs/vitepress' }
+    ]
+  }
+})

docs/api/index.md

@@ -0,0 +1,3 @@
+# API
+
+🚧 Work is still in progress with this one... 🚧