Skip to content

Commit ef36036

Browse files
committed
📝 add Why, Showcase, Slidev features, Combine with and Ideas sections to README
1 parent 7a78384 commit ef36036

1 file changed

Lines changed: 42 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ Embed a live VS Code IDE in your [Slidev](https://sli.dev) presentations.
99

1010
Powered by [coderaft](https://github.com/pithings/coderaft), a zero-dependency redistribution of code-server that installs in under a second.
1111

12+
## 🎤 Why
13+
14+
I often give live presentations where I need to show and modify code in real time. Switching between slides and a local IDE breaks the flow — alt-tabbing mid-talk is jarring for the audience and for me.
15+
16+
`slidev-addon-livecode` embeds a full VS Code instance directly into your slides, so your code demos stay in context. No context switching, no alt-tabbing.
17+
18+
> 🗞️ **Inspired by** [Stop Alt-Tabbing: Embed an IDE in Your Live-Coding Slides](https://mickaelalvs.dev/articles/stop-alt-tabbing-embed-ide-live-coding-slides).
19+
1220
## 📦 Install
1321

1422
```bash
@@ -85,7 +93,7 @@ Use `disableInitialFocus` to prevent VS Code from stealing keyboard focus when y
8593
<Editor session="demo" disableInitialFocus />
8694
```
8795

88-
Focus is held on the slide for 5 seconds after VS Code loads, then released normally. The user can interact with VS Code freely after that.
96+
Focus is held on the slide, after an interaction, the user can interact with VS Code freely after that.
8997

9098
## ⚡ Preload
9199

@@ -144,16 +152,49 @@ Per-component props override these values.
144152
| `startTimeout` | `number` | `30000` | Max startup time in ms before the session is marked as failed. |
145153
| `zoom` | `number` | `1` | Scale factor for the VS Code UI (e.g. `0.8` for 80%). |
146154

155+
## 🎬 Showcase
156+
157+
A demo deck lives in `showcase/`. Run it with:
158+
159+
```bash
160+
pnpm run dev
161+
```
162+
## đź§© Slidev features
163+
164+
`<Editor />` works alongside all [Slidev built-in features](https://sli.dev/features/), drag, resize, click animations, and more. Compose it freely with the rest of your slide content.
165+
147166
## ⚠️ Static exports
148167

149168
The `<Editor />` component requires Slidev dev mode. In static exports (`slidev build`), it renders a placeholder instead. Plan your demos accordingly.
150169

170+
## đź”— Combine with
171+
172+
Pair `<Editor />` with other addons for a fully self-contained demo environment — no need to leave your slides at all:
173+
174+
- **[slidev-addon-liveshell](https://npmx.dev/package/slidev-addon-liveshell)** — embed a live terminal directly in your slide alongside the editor.
175+
- **An `<iframe>` pointing to your dev server** — embed your running app next to the editor. Edit code in VS Code, and the hot reload updates the iframe in real time, all without leaving the presentation.
176+
177+
```vue
178+
<div class="flex gap-2 flex-1">
179+
<Editor session="demo" class="w-1/2" />
180+
<iframe src="http://localhost:5173" class="w-1/2" />
181+
</div>
182+
```
183+
151184
## 🏷️ Requirements
152185

153186
- `@slidev/client >= 52`
154187
- `coderaft >= 0.0.25`
155188
- `vue >= 3.4`
156189

190+
## đź’ˇ Ideas
191+
192+
Features that may land in a future release:
193+
194+
- **Open a specific file on load** — open a file directly from `<Editor />` props, pending [coderaft#4](https://github.com/pithings/coderaft/pull/4)
195+
- **Pre-installed extensions** — declare VS Code extensions to install automatically when the session starts.
196+
- **Keyboard shortcuts** — configure custom keybindings per session via props.
197+
157198
## Maintainer
158199

159200
Made by [Mickaël Alves](https://mickaelalvs.dev) — [mickaelalvs.dev](https://mickaelalvs.dev)

0 commit comments

Comments
 (0)