Skip to content

Commit e7a67e2

Browse files
committed
docs: add screenshots
1 parent c1d00c6 commit e7a67e2

24 files changed

Lines changed: 84 additions & 0 deletions

docs/.vitepress/theme/style.css

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,3 +28,16 @@
2828

2929
--vp-local-search-highlight-bg: #adc77f;
3030
}
31+
32+
.screenshot img {
33+
transform: scale(1.05);
34+
}
35+
36+
.screenshot figcaption {
37+
text-align: center;
38+
font-size: 0.875rem;
39+
color: var(--vp-c-text-3);
40+
margin-top: -0.5rem;
41+
padding-bottom: 1rem;
42+
font-style: italic;
43+
}

docs/examples/vite-devframe-hub.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ A protocol-witness host: roughly 120 lines of Vite plugin code that wire [`@devf
88

99
Package: `vite-devframe-hub` · framework: **Vanilla TypeScript (Vite)**
1010

11+
<figure class="screenshot">
12+
<img src="/screenshots/hub-1.png" alt="Hub screenshot" />
13+
<figcaption>Playground screenshot</figcaption>
14+
</figure>
15+
1116
## What it proves
1217

1318
- `createHubContext()` boots a hub without any Vite-specific code path.

docs/guide/hub.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ outline: deep
66

77
`@devframes/hub` extends devframe with the orchestration features that only make sense when many devtools share a UI: a dock registry, terminal aggregation, message/toast queue, and a command palette. It does not ship UI — each framework kit (e.g. `@vitejs/devtools-kit`) provides its own UI on top of the hub's RPC + shared-state protocol.
88

9+
<figure class="screenshot">
10+
<img src="/screenshots/hub-1.png" alt="Hub screenshot" />
11+
<figcaption>Hub allows orchestration of multiple devtools through a unified interface (example from <a href="/examples/vite-devframe-hub.html">A Playground</a>)</figcaption>
12+
</figure>
13+
914
## What the hub adds
1015

1116
A hub-aware node context (`DevframeHubContext`) extends `DevframeNodeContext` with four subsystems:

docs/plugins/a11y.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ An accessibility inspector that runs [axe-core](https://github.com/dequelabs/axe
88

99
Package: `@devframes/plugin-a11y` · framework: **Solid + Vite**
1010

11+
<figure class="screenshot">
12+
<img src="/screenshots/plugin-a11y-1.png" alt="Accessibility Inspector screenshot" />
13+
<figcaption>Hover to highlight the offending element in the page</figcaption>
14+
</figure>
15+
16+
<figure class="screenshot">
17+
<img src="/screenshots/plugin-a11y-copy-prompts.png" alt="Accessibility Inspector screenshot" />
18+
<figcaption style="margin-top: 2rem;">Generate prompts for fixing accessibility issues</figcaption>
19+
</figure>
20+
1121
## What it does
1222

1323
The plugin is three pieces, two of them browser-side:

docs/plugins/assets.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Browse, preview, upload, rename, and delete the files in a directory, built as a
88

99
Package: `@devframes/plugin-assets` · framework: **Vue + @antfu/design**
1010

11+
<figure class="screenshot">
12+
<img src="/screenshots/plugin-assets-1.png" alt="Assets plugin screenshot" />
13+
<figcaption>Assets plugin showing the file browser and details panel</figcaption>
14+
</figure>
15+
1116
## What it does
1217

1318
Search by name and filter by type from an inline chip row, switch between a thumbnail grid (grouped by folder) and a file tree, and open a resizable right-hand details panel with a live preview (image, video, audio, font, or text), file metadata, and ready-to-copy usage snippets (`<img>`, CSS `background-image`, `@font-face`, a download link). Upload files with the toolbar button (native file picker) or by dropping them anywhere on the frame, and select multiple assets to delete them together. A live file watcher keeps every connected client's listing in sync with changes made outside the UI.

docs/plugins/code-server.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ Run VS Code in the browser as a devframe panel. The plugin detects a local edito
88

99
Package: `@devframes/plugin-code-server` · framework: **Vue**
1010

11+
12+
<figure class="screenshot">
13+
<img src="/screenshots/plugin-code-server-1.png" alt="Code Server plugin screenshot" />
14+
<figcaption>Launcher before Code Server starts</figcaption>
15+
</figure>
16+
17+
<figure class="screenshot">
18+
<img src="/screenshots/plugin-code-server-2.png" alt="Code Server plugin screenshot" />
19+
<figcaption>Code Server plugin showing the embedded editor in browser</figcaption>
20+
</figure>
21+
1122
## What it does
1223

1324
- **Detection** — on startup it probes the resolved binary with `--version`. When none is found, the launcher renders install instructions instead of a launch button.

docs/plugins/data-inspector.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ An interactive query workbench for live server-side objects, built as a **Vue**
88

99
Package: `@devframes/plugin-data-inspector` · framework: **Vue + Vite**
1010

11+
<figure class="screenshot">
12+
<img src="/screenshots/plugin-data-inspector-1.png" alt="Data Inspector screenshot" />
13+
<figcaption>Query workbench with results and data shape panel</figcaption>
14+
</figure>
15+
16+
<figure class="screenshot">
17+
<img src="/screenshots/plugin-data-inspector-2.png" alt="Data Inspector screenshot" />
18+
<figcaption>Query data with advanced Jora syntax</figcaption>
19+
</figure>
20+
1121
## What it does
1222

1323
- **Query workbench** — a CodeMirror jora editor with syntax highlighting and server-computed autocomplete; queries auto-run as you type, with a client-side syntax gate so malformed input never hits the wire. A toolbar copies the query, and the editor pairs with expand-all / collapse-all and copy-as-JSON controls over the results. Source, query, filters, and the auto-rerun setting persist in the URL hash, so any workbench state is shareable (see [Deep linking](#deep-linking)).

docs/plugins/git.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ A repository dashboard built as a **Next.js (App Router) + shadcn/ui** SPA over
88

99
Package: `@devframes/plugin-git` · framework: **React (Next.js) + shadcn/ui**
1010

11+
<figure class="screenshot">
12+
<img src="/screenshots/plugin-git-1.png" alt="Git plugin screenshot" />
13+
<figcaption>Git plugin showing repository status and commit graph in an hub example</figcaption>
14+
</figure>
15+
1116
## What it does
1217

1318
Status, a SourceTree-style commit graph, branches, and diffs are read-only. Staging, unstaging, and committing become available when write mode is enabled — and stay gated behind the repository's actual write permission in the UI.

docs/plugins/inspect.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ A self-inspector for any devframe connection, built as a **Vue** SPA. It browses
88

99
Package: `@devframes/plugin-inspect` · framework: **Vue + Vite**
1010

11+
<figure class="screenshot">
12+
<img src="/screenshots/plugin-inspect-1.png" alt="Devframe Inspector screenshot" />
13+
<figcaption>Devframe Inspector showing rpc functions list</figcaption>
14+
</figure>
15+
16+
<figure class="screenshot">
17+
<img src="/screenshots/plugin-inspect-2.png" alt="Devframe Inspector screenshot" />
18+
<figcaption>Devframe Inspector showing agent tools</figcaption>
19+
</figure>
20+
21+
<figure class="screenshot">
22+
<img src="/screenshots/plugin-inspect-3.png" alt="Devframe Inspector screenshot" />
23+
<figcaption>Devframe Inspector showing history panels</figcaption>
24+
</figure>
25+
1126
## What it does
1227

1328
- **Functions** — every registered RPC function with its type, JSON-serializable / snapshot flags, args and return JSON Schema, and agent exposure. Read-only `query` / `static` functions can be invoked inline and their result envelope inspected.

docs/plugins/terminals.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ A portable terminal panel built as a **Svelte** SPA on top of [xterm.js](https:/
88

99
Package: `@devframes/plugin-terminals` · framework: **Svelte + xterm.js**
1010

11+
<figure class="screenshot">
12+
<img src="/screenshots/plugin-terminals-1.png" alt="Terminals screenshot" />
13+
<figcaption>Terminals plugin allowing interactive and read-only terminal sessions in the browser</figcaption>
14+
</figure>
15+
1116
## What it does
1217

1318
- **Read-only output** — stream the output of a command into a terminal view via devframe's [streaming channels](/guide/streaming).

0 commit comments

Comments
 (0)