slidev-addon-eink-remote

A presenter remote for Slidev, made for e-ink devices.

What it does

This addon adds a remote page (/eink) to your Slidev presentation. The page is made for e-ink devices such as the Boox Palma.

It shows:

• An elapsed presentation timer
• Speaker notes for the current slide
• Step buttons (‹ STEP and STEP ›) to advance through v-click animations
• Slide buttons (PREV and NEXT) to jump between slides

The remote stays in sync with the main presentation. You can control the slides from either device.

Requirements

• Node.js 20.12.0 or later
• Slidev 52.0.0 or later

Install

npm install slidev-addon-eink-remote

Activate

Add the addon to the frontmatter of your slides.md file:

---
addons:
  - slidev-addon-eink-remote
---

Use

Start Slidev:

npm run dev

Open the main presentation on your computer.

On your e-ink device, open http://<computer-ip>:3030/eink. Replace <computer-ip> with the IP address of your computer.

Step buttons

The step buttons are in a row above the slide buttons. The row is always visible.

On a slide that has v-click animations, use the step buttons to move through each step one at a time. The indicator in the center shows the current step and the total steps (for example, 2 / 5).

When you reach the last step, STEP › goes to the next slide. When you are at the first step, ‹ STEP goes to the previous slide.

On a slide with no v-click animations, the step buttons work the same as the slide buttons.

Slide buttons

Use the PREV and NEXT buttons to jump to the previous or next slide. These buttons always skip all v-click steps and go to the start of the slide.

Timer

Tap the timer at the top to start or pause it. Tap RESET to reset the timer.

Password

You can set a password for the remote page. When you start Slidev, pass the password:

npm run dev -- --remote=your-password

When a password is set, the remote page asks for it before you can use the page.

Develop

To work on this addon locally:

git clone https://github.com/Chromadream/slidev-addon-eink-remote.git
cd slidev-addon-eink-remote
npm install
npm link
npm link slidev-addon-eink-remote

Then add the addon to the frontmatter of your slides file, as shown in the Activate section.

Run the dev server with npm run dev from the addon directory.

Design for e-ink devices

The remote page uses these design principles:

• No animations or CSS transitions
• High contrast (black on near-white background)
• Large touch targets (minimum 64px buttons)
• No hover states (touch-only interaction)
• No reliance on color

These principles prevent ghosting on e-ink screens.

License

MIT