feat: deploy example to GitHub Pages

Author: binzcodes

.github/workflows/deploy.yml

@@ -0,0 +1,39 @@
+name: Deploy to GitHub Pages
+
+on:
+  # Trigger the workflow every time you push to the `main` branch
+  # Using a different branch name? Replace `main` with your branch’s name
+  push:
+    branches: [main, feat/example-site]
+  # Allows you to run this workflow manually from the Actions tab on GitHub.
+  workflow_dispatch:
+
+# Allow this job to clone the repo and create a page deployment
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout your repository using git
+        uses: actions/checkout@v4
+      - name: Install, build, and upload your site output
+        uses: withastro/action@v2
+        with:
+            path: examples/example-site # The root location of your Astro project inside the repository. (optional)
+            node-version: 20 # The specific version of Node that should be used to build your site. Defaults to 18. (optional)
+            package-manager: pnpm@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

examples/example-site/astro.config.mjs

@@ -2,4 +2,7 @@
 import {defineConfig} from "astro/config";
 
 // https://astro.build/config
-export default defineConfig({});
+export default defineConfig({
+  site: "https://binzcodes.github.io",
+  base: "visor",
+});

examples/example-site/package.json

@@ -12,6 +12,8 @@
   "dependencies": {
     "astro": "^4.16.7",
     "@astrojs/check": "^0.9.4",
+    "sharp": "^0.33.5",
+    "sharp-ico": "^0.1.5",
     "typescript": "^5.6.3",
     "@binz/visor": "workspace:*"
   }

examples/example-site/src/pages/manifest.json.ts

@@ -1,8 +1,7 @@
-import path from "node:path";
 import type {APIRoute} from "astro";
 import Manifest from "@binz/visor/src/lib/manifest";
 
-import favicon from "../images/favicon.ico";
+import favicon from "./../images/Logo.svg";
 
 const faviconPngSizes = [192, 512];