Merge pull request #441 from jwetzell/chore/docs

add separate docs

.github/release.yml

@@ -21,6 +21,9 @@ changelog:
     - title: Web UI 🌐
       labels:
         - webui
+    - title: Docs 📄
+      labels:
+        - docs
     - title: Other Changes
       labels:
         - '*'

.github/workflows/publish-docs.yml

@@ -0,0 +1,38 @@
+name: Publish showbridge docs to docs site
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+          cache-dependency-path: 'docs/package-lock.json'
+
+      - name: Install Node.js dependencies
+        run: npm ci
+        working-directory: ./docs
+
+      - run: npm run build
+        working-directory: ./docs
+
+      - name: publish docs
+        uses: SamKirkland/FTP-Deploy-Action@v4.3.5
+        with:
+          server: ${{secrets.FTP_URL}}
+          username: ${{secrets.DOCS_FTP_USERNAME}}
+          password: ${{secrets.DOCS_FTP_PASSWORD}}
+          local-dir: ./docs/dist/
+          server-dir: docs/
+          port: 21
+          protocol: ftps

docs/.gitignore

@@ -0,0 +1,18 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production

docs/astro.config.mjs

@@ -0,0 +1,41 @@
+import starlight from '@astrojs/starlight';
+import { defineConfig } from 'astro/config';
+
+// https://astro.build/config
+export default defineConfig({
+  integrations: [
+    starlight({
+      title: 'showbridge',
+      favicon: '/favicon.ico',
+      social: {
+        github: 'https://github.com/jwetzell/showbridge',
+      },
+      sidebar: [
+        {
+          label: 'showbridge',
+          autogenerate: { directory: '/showbridge' },
+        },
+        {
+          label: 'Guides',
+          autogenerate: { directory: 'guides' },
+        },
+        {
+          label: 'Reference',
+          autogenerate: { directory: 'reference' },
+        },
+        { label: 'Demo', link: 'https://demo.showbridge.io/', attrs: { target: '_blank' } },
+        {
+          label: 'More Docs',
+          items: [
+            { label: 'Lib JSDocs', link: 'https://docs.showbridge.io/lib/', attrs: { target: '_blank' } },
+            {
+              label: 'Config JSON Schema',
+              link: 'https://docs.showbridge.io/schema/config',
+              attrs: { target: '_blank' },
+            },
+          ],
+        },
+      ],
+    }),
+  ],
+});