Queek docs

Templates and designs

Dress your theme as real businesses, each with its own demo store.

A template is one business your theme serves. A design is one demo store of a template. The main template's design is demo.json; each extra design is demos/<id>.json, declared in theme.config.ts.

Add a template

Name the business keys it is for with for, using only keys from docs/business-vocabulary.json — the vocabulary file the starter ships. A template for a whole business leads with its business category; a template for one kind of product names only its product keys.

Add a design

Write demos/<id>.json in the same shape as demo.json, and declare it with its template key. Give it its own home page: no two designs may list the same sections in the same order. Every design ships about, sales and landing pages.

Write a description

Each design needs a description of at most 300 characters: who it fits, the look, its signature sections, and what photos it needs. Queek's AI picks templates for merchants from it, so write for a model choosing on a merchant's behalf.

Take screenshots

Capture every design
npm run screenshot

The main design's shot is theme.jpg; each other design's is demos/<id>.jpg. Run it again after a design changes.

Replace the placeholders

The starter's products, photos and theme description are stand-ins. Every template needs its own products and licensed photos — never another store's and never a real brand's. The check rejects the stand-ins until you replace them.

Write copy as a template

Queek publishes a template's words onto new stores unchanged, so write for any store in the business, never for your demo store. No store names, no places, no prices, no offers, no promises only the vendor can make — delivery times, returns, guarantees — and no founding dates, emails or phone numbers. Testimonials and reviews are exempt.

Detail for each rule is in THEME.md's Templates section.

On this page