Skip to content

Commit 7a78384

Browse files
committed
📝 add badges and maintainer section to README
1 parent 630e1d6 commit 7a78384

1 file changed

Lines changed: 22 additions & 10 deletions

File tree

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# 🛶 slidev-addon-livecode
22

3+
[![npmx](https://img.shields.io/npm/v/slidev-addon-livecode?style=for-the-badge&logo=npm&logoColor=white&label=npmx&labelColor=000000&color=18181b)](https://npmx.dev/package/slidev-addon-livecode)
4+
[![npm](https://img.shields.io/npm/v/slidev-addon-livecode?style=for-the-badge&logo=npm&logoColor=white&labelColor=cb0000&color=18181b)](https://www.npmjs.com/package/slidev-addon-livecode)
5+
[![license](https://img.shields.io/github/license/mickaelalvs/slidev-addon-livecode?style=for-the-badge&labelColor=3da639&color=18181b)](./LICENSE)
6+
[![slidev](https://img.shields.io/badge/slidev-%3E%3D52-18181b?style=for-the-badge&logo=slidev&logoColor=white&labelColor=2b90b6&color=18181b)](https://sli.dev)
7+
38
Embed a live VS Code IDE in your [Slidev](https://sli.dev) presentations.
49

510
Powered by [coderaft](https://github.com/pithings/coderaft), a zero-dependency redistribution of code-server that installs in under a second.
@@ -21,7 +26,7 @@ addons:
2126

2227
## 🚀 Basic usage
2328

24-
```md
29+
```yaml
2530
---
2631
addons:
2732
- livecode
@@ -36,21 +41,21 @@ That's it. When you navigate to the slide, a VS Code instance starts automatical
3641

3742
## 📂 Open a specific workspace
3843

39-
```md
44+
```vue
4045
<Editor session="demo" defaultFolder="/path/to/your/project" />
4146
```
4247

4348
Both absolute and relative paths are supported. Relative paths are resolved from the Slidev project root:
4449

45-
```md
50+
```vue
4651
<Editor session="demo" defaultFolder=".." />
4752
```
4853

4954
## 🌗 Color scheme
5055

5156
Force VS Code to use a specific color theme:
5257

53-
```md
58+
```vue
5459
<Editor session="demo" colorScheme="dark" />
5560
<Editor session="demo" colorScheme="light" />
5661
```
@@ -61,7 +66,7 @@ If omitted, the color scheme automatically follows your Slidev presentation's `c
6166

6267
VS Code can appear too large inside a slide. Use the `zoom` prop to scale it down:
6368

64-
```md
69+
```vue
6570
<Editor session="demo" :zoom="0.8" />
6671
```
6772

@@ -76,7 +81,7 @@ livecode:
7681
7782
Use `disableInitialFocus` to prevent VS Code from stealing keyboard focus when you navigate to a slide — arrow keys keep working for Slidev navigation:
7883

79-
```md
84+
```vue
8085
<Editor session="demo" disableInitialFocus />
8186
```
8287

@@ -86,7 +91,7 @@ Focus is held on the slide for 5 seconds after VS Code loads, then released norm
8691

8792
Use `preload` to warm up the VS Code session before the user reaches the slide. Slidev mounts adjacent slides in the background, so the session can start while the user is still on the previous slide:
8893

89-
```md
94+
```vue
9095
<Editor session="demo" preload />
9196
```
9297

@@ -96,7 +101,7 @@ Combine with `disableInitialFocus` for a seamless experience — the IDE is read
96101

97102
By default, navigating away from a slide stops the session. Use `persist` to keep it running:
98103

99-
```md
104+
```vue
100105
<Editor session="demo" persist />
101106
```
102107

@@ -143,12 +148,19 @@ Per-component props override these values.
143148

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

146-
## Requirements
151+
## 🏷️ Requirements
147152

148153
- `@slidev/client >= 52`
149154
- `coderaft >= 0.0.25`
150155
- `vue >= 3.4`
151156

157+
## Maintainer
158+
159+
Made by [Mickaël Alves](https://mickaelalvs.dev) — [mickaelalvs.dev](https://mickaelalvs.dev)
160+
161+
[![Bluesky](https://img.shields.io/badge/Bluesky-mickaelalvs.dev-0285FF?style=for-the-badge&logo=bluesky&logoColor=white)](https://bsky.app/profile/mickaelalvs.dev)
162+
[![GitHub](https://img.shields.io/badge/GitHub-mickaelalvs-18181b?style=for-the-badge&logo=github&logoColor=white)](https://github.com/mickaelalvs)
163+
152164
## License
153165

154-
MIT
166+
[![license](https://img.shields.io/github/license/mickaelalvs/slidev-addon-livecode?style=for-the-badge&labelColor=3da639&color=18181b)](./LICENSE)

0 commit comments

Comments
 (0)