Feature/docs

.github/workflows/docs.yml

@@ -0,0 +1,68 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  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:
+    name: Build VitePress site
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Needed for lastUpdated feature
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+          cache-dependency-path: docs/package-lock.json
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Install dependencies
+        working-directory: docs
+        run: npm ci
+
+      - name: Build VitePress site
+        working-directory: docs
+        run: npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    name: Deploy to GitHub Pages
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+

.gitignore

@@ -366,3 +366,7 @@ FodyWeavers.xsd
 *.received.*
 
 .idea
+
+# Docs
+/docs/.vitepress/cache/
+/docs/.vitepress/dist/

docs/.vitepress/config.mts

@@ -0,0 +1,93 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: "EF Core Projectables",
+  description: "Flexible projection magic for EF Core — use properties and methods directly in your LINQ queries",
+  head: [
+    ['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }],
+    ['meta', { property: 'og:image', content: 'https://projectables.github.io/social.svg' }],
+    ['meta', { property: 'og:type', content: 'website' }],
+    ['meta', { name: 'twitter:card', content: 'summary_large_image' }],
+    ['meta', { name: 'twitter:image', content: 'https://projectables.github.io/social.svg' }],
+  ],
+  themeConfig: {
+    logo: '/logo.svg',
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Guide', link: '/guide/introduction' },
+      { text: 'Reference', link: '/reference/projectable-attribute' },
+      { text: 'Advanced', link: '/advanced/how-it-works' },
+      { text: 'Recipes', link: '/recipes/computed-properties' },
+    ],
+
+    sidebar: {
+      '/guide/': [
+        {
+          text: 'Getting Started',
+          items: [
+            { text: 'Introduction', link: '/guide/introduction' },
+            { text: 'Installation', link: '/guide/installation' },
+            { text: 'Quick Start', link: '/guide/quickstart' },
+          ]
+        },
+        {
+          text: 'Core Concepts',
+          items: [
+            { text: 'Projectable Properties', link: '/guide/projectable-properties' },
+            { text: 'Projectable Methods', link: '/guide/projectable-methods' },
+            { text: 'Extension Methods', link: '/guide/extension-methods' },
+          ]
+        }
+      ],
+      '/reference/': [
+        {
+          text: 'Reference',
+          items: [
+            { text: '[Projectable] Attribute', link: '/reference/projectable-attribute' },
+            { text: 'Compatibility Mode', link: '/reference/compatibility-mode' },
+            { text: 'Null-Conditional Rewrite', link: '/reference/null-conditional-rewrite' },
+            { text: 'Expand Enum Methods', link: '/reference/expand-enum-methods' },
+            { text: 'Use Member Body', link: '/reference/use-member-body' },
+            { text: 'Diagnostics', link: '/reference/diagnostics' },
+          ]
+        }
+      ],
+      '/advanced/': [
+        {
+          text: 'Advanced',
+          items: [
+            { text: 'How It Works', link: '/advanced/how-it-works' },
+            { text: 'Query Compiler Pipeline', link: '/advanced/query-compiler-pipeline' },
+            { text: 'Block-Bodied Members', link: '/advanced/block-bodied-members' },
+            { text: 'Limitations', link: '/advanced/limitations' },
+          ]
+        }
+      ],
+      '/recipes/': [
+        {
+          text: 'Recipes',
+          items: [
+            { text: 'Computed Entity Properties', link: '/recipes/computed-properties' },
+            { text: 'Enum Display Names', link: '/recipes/enum-display-names' },
+            { text: 'Nullable Navigation Properties', link: '/recipes/nullable-navigation' },
+            { text: 'Reusable Query Filters', link: '/recipes/reusable-query-filters' },
+          ]
+        }
+      ],
+    },
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/koenbeuk/EntityFrameworkCore.Projectables' }
+    ],
+
+    search: {
+      provider: 'local'
+    },
+
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © EntityFrameworkCore.Projectables Contributors'
+    }
+  }
+})