Skip to content
14-day free trial, no card9 languages176 business types · 50 apps
EN· USD
Try a live demoStart free trial

Write a theme spec

Add a theme to a business type, validate it with check:business and ship it through the built-in module pipeline.

  • about 8 min

Themes are core code, owned by the built-in sub-module settings/business (paths src/lib/business/** and the business page). There is no separate theme package format: you edit the data and ship the sub-module.

A theme entry in src/lib/business/data/food.ts
{
  id: "coffee-shop-harbour",
  name: "Harbour",
  mood: "Deep navy and brass — calm, premium and made for a waterfront café.",
  mode: "dark",
  palette: { from: "#1e3a8a", to: "#0f766e", accent: "#f59e0b" },
  angle: 150,
  radius: "0.75rem",
  fonts: { display: "Playfair Display", body: "DM Sans" },
  layout: "editorial",
  art: "waves",
},
  1. Export the owning sub-module: npm run module:pack settings/business (or “Export zip” on its card under System → Apps → Plugins → Built-in modules).

  2. Add the theme to the business's themes array; keep the id prefixed with the business id and use font names from THEME_FONTS.

  3. Run npm run check:business — it validates ids, fonts, icons, app keys, layouts and colour contrast for every spec.

  4. Import the zip (“Import a module zip”) and run Import & rebuild; the pipeline typechecks, builds and swaps with rollback.

  5. Open Business & themes and click Use this theme to try it.

On the hosted platform core changes are made by the platform team. To offer a look to every workspace without a core change, sell a marketplace theme (zmle.theme/1, next lesson).

Written from: src/lib/business/types.ts, src/lib/business/data/food.ts, src/lib/modules/registry.ts, docs/MODULES.md, scripts/business-check.ts, docs/DEVELOPERS/THEME-SPEC.md