Documentation Development

Running in Development Mode

The documentation includes live, interactive examples embedded via iframes. To see them working locally:

Open two terminals:

Terminal 1 - Start all example servers:

bash

cd docs
npm run dev:examples

Terminal 2 - Start documentation:

bash

cd docs
npm run dev

Then visit http://localhost:5173 - all embedded examples will be working!

If you only want to test specific examples, you can run them individually:

bash

# Example: run vanilla basic example
cd examples/01-vanilla-basic
npm run dev

Then start the docs as normal. The iframe will connect to whichever examples are running.

To build everything for production:

bash

cd docs
npm run build

This will:

The examples are served as static files alongside the documentation in production.

Each example runs on its own port in development: