deploy: add live example deployment to GitHub Pages

- Add GitHub Actions workflow to build and deploy examples
- Update Vite config with `base` and `build` options for examples
- Add `examples:build` npm script for building examples
- Link live examples in README
- Update .gitignore to exclude `dist-examples`

Author: tomkp

.github/workflows/deploy-examples.yml

@@ -0,0 +1,34 @@
+name: Deploy Examples to GitHub Pages
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build examples
+        run: npm run examples:build
+
+      - name: Deploy to gh-pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./dist-examples

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 dist
+dist-examples
 coverage
 .DS_Store
 *.log

README.md

@@ -6,6 +6,8 @@ Modern, accessible, TypeScript-first split pane component for React.
 ![NPM license](https://img.shields.io/npm/l/react-split-pane.svg?style=flat)
 [![Bundle size](https://img.shields.io/bundlephobia/minzip/react-split-pane)](https://bundlephobia.com/package/react-split-pane)
 
+**[Live Examples](https://tomkp.github.io/react-split-pane)**
+
 ## ✨ Features
 
 - 🪝 **Hooks-based** - Built with modern React patterns

examples/vite.config.ts

@@ -5,11 +5,16 @@ import { resolve } from 'path';
 export default defineConfig({
   plugins: [react()],
   root: __dirname,
+  base: '/react-split-pane/',
   resolve: {
     alias: {
       '../src': resolve(__dirname, '../src'),
     },
   },
+  build: {
+    outDir: resolve(__dirname, '../dist-examples'),
+    emptyOutDir: true,
+  },
   server: {
     port: 3000,
     open: true,

package.json

@@ -41,6 +41,7 @@
     "format:check": "prettier --check src examples",
     "typecheck": "tsc --noEmit",
     "examples": "vite --config examples/vite.config.ts",
+    "examples:build": "vite build --config examples/vite.config.ts",
     "prepublishOnly": "npm run test && npm run build"
   },
   "repository": {