diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..e9ede02 --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,38 @@ +name: Deploy GitHub Pages + +on: + push: + branches: [main] + paths: + - 'docs/**' + workflow_dispatch: + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: true + +jobs: + deploy: + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - uses: actions/checkout@v4 + + - name: Setup Pages + uses: actions/configure-pages@v5 + + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: docs + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 9cb07c7..54a4067 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Node.js](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org/) [![Docker](https://img.shields.io/badge/docker-ghcr.io-blue)](https://github.com/MarlBurroW/pinchchat/pkgs/container/pinchchat) +[![Website](https://img.shields.io/badge/website-GitHub%20Pages-blueviolet)](https://marlburrow.github.io/pinchchat/) **A sleek, dark-themed webchat UI for [OpenClaw](https://github.com/openclaw/openclaw) — monitor sessions, stream responses, and inspect tool calls in real-time.** diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..9601591 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,357 @@ + + + + + + PinchChat — Webchat UI for OpenClaw + + + + + + + + + +
+ +
+
+ +

PinchChat

+

A sleek, dark-themed webchat UI for OpenClaw. Monitor sessions, stream AI responses, and inspect tool calls — all in real-time.

+
+ 🚀 Get Started + ⭐ GitHub +
+ +

Run it now with one command:

+
docker run -p 3000:80 ghcr.io/marlburrow/pinchchat:latest
+
+
+ +
+
+

Features

+
+
+
🌑
+

Dark Neon Theme

+

Beautiful dark interface with neon accents, built with Tailwind CSS v4. Easy on the eyes during long sessions.

+
+
+
⚡
+

Real-time Streaming

+

Watch the AI think in real-time with streamed responses. Full WebSocket integration with your OpenClaw gateway.

+
+
+
🔧
+

Tool Call Inspector

+

Expandable tool call badges with syntax-highlighted JSON. See exactly what your agent is doing.

+
+
+
📊
+

Token Progress Bars

+

Track token usage per session in real-time. Stay aware of costs and context window limits.

+
+
+
📋
+

Session Sidebar

+

Browse all active sessions with live activity indicators. Switch between conversations instantly.

+
+
+
🔐
+

Runtime Login

+

Enter gateway credentials at runtime — no secrets baked into the build. Perfect for shared deployments.

+
+
+
🖼️
+

Inline Images

+

Images render inline with a lightbox for full-size viewing. Supports PNG, JPG, GIF, and WebP.

+
+
+
🌐
+

i18n Support

+

Multi-language interface with English and French built-in. Easy to extend with new translations.

+
+
+
📝
+

Markdown Rendering

+

Full GitHub Flavored Markdown with syntax-highlighted code blocks, tables, and more.

+
+
+
+
+ +
+
+

See it in Action

+
+ 📸 Screenshots coming soon — contributions welcome! +
+
+
+ + + +