DemoZap ⚡

Create demo components in a zap

Maintaining example code and demo separately makes it painful, it's easy to get them out of sync 🙅

Code can't lie, documentation can 💥

DemoZap CLI keeps your code up to date with demo 💪

Usage

• Name component files as [component_name].demozap.jsx
• Run npx demozap generate

Use created demos 🎉

Demo 💥

Install

# React
npm install -D react-demo-tab
# Svelte
npm install -D svelte-demo-tab
# Vue
npm install -D vue-demo-tab

Generated Demos

• Generated demo files are prefixed with _:
  MyComponent.demozap.jsx → _MyComponent.jsx
• or set custom prefix:
  npx demozap generate --prefix=CustomPrefix

Built with DemoZap

• React Tilt - DemoZap
• Mighty Mouse - DemoZap
• Magnetic Board - DemoZap

Manually create demos

To manually create demos use DemoTab component.

Contributing

All contributions are welcome!