Merge pull request #1 from screeenly/deploy

Add deploy Workflow

.github/workflows/deploy.yml

@@ -0,0 +1,64 @@
+# Sample workflow for building and deploying a VitePress site to GitHub Pages
+#
+name: Deploy VitePress site to Pages
+
+on:
+  # Runs on pushes targeting the `main` branch. Change this to `master` if you're
+  # using the `master` branch as the default branch.
+  push:
+    branches: [main]
+
+  # 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: npm # or pnpm / yarn
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Install dependencies
+        run: npm ci # or pnpm install / yarn install / bun install
+      - name: Build with VitePress
+        run: npm run docs:build # or pnpm docs:build / yarn docs:build / bun run docs:build
+      - 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/deploy-pages@v4

.vitepress/config.mts

@@ -12,7 +12,10 @@ export default defineConfig({
 
     themeConfig: {
         // https://vitepress.dev/reference/default-theme-config
-        logo: '/assets/screeenly-3-logo.svg',
+        logo: {
+            src: '/assets/screeenly-3-logo.svg',
+            alt: 'screeenly Logo',
+        },
         head: [
             ['link', {rel: 'icon', href: '/favicon.ico'}]
         ],

src/reference/index.md

@@ -8,25 +8,20 @@ This page contains the Open API specification for the screeenly API. Checkout al
 
 Feel free to explore the API documentation below. If you have a valid API key, you can also try out the API directly from this page.
 
-<script setup>
-import { computed } from 'vue';
-import { useData } from 'vitepress';
+<script setup async>
 import { ApiReference } from '@scalar/api-reference';
 import '@scalar/api-reference/style.css';
 
-const { isDark } = useData();
-
-const configuration = computed(function () {
-return {
+const configuration = {
     spec: {
-        url: '/assets/screeenly-api.yaml',
+        // url: '/assets/screeenly-api.yaml',
+        url: 'https://3.screeenly.com/screeenly-api.yaml',
     },
     searchHotKey: 'l',
     withDefaultFonts: false,
-    theme: isDark.value ? 'moon' : 'default',
+    theme: 'default',
+    proxy: 'https://proxy.scalar.com',
 };
-
-});
 </script>
 
 <div style="position: relative;">