Skip to content
Zenso Logozenso.inkDocs

Widget SDK Quickstart

Develop your first Zenso widget with live hot-reloading in less than five minutes.

1. Clone the Starter Template

Section titled “1. Clone the Starter Template”

Clone the official public starter repository:

Terminal window
git clone https://github.com/zensoink/zenso-plugin-template.git my-widget
cd my-widget
pnpm install

2. Start the Local Dev Server

Section titled “2. Start the Local Dev Server”

Launch the local development environment powered by @zenso/vite-plugin:

Terminal window
pnpm dev

Open http://localhost:5173 in your browser. You will see a live preview simulating your widget inside an actual e-paper canvas.

3. Test with Mock Data

Section titled “3. Test with Mock Data”

Edit mock/plugin.json to simulate various states (e.g. long calendar titles, missing photos, network errors). Any edit to index.liquid or style.css updates instantly without reloading.