Skip to main content

Liquid Theme Quickstart

Goal: pull a Liquid theme locally, run it with fixture or live shop data, and preview changes before publishing.
shoppex theme dev requires a Liquid theme-package.json.

Pull A Hosted Theme

For a real merchant theme:
shoppex auth login --api-key shx_your_key
shoppex theme pull --theme 11111111-1111-4111-8111-111111111111 --out ./my-theme
cd ./my-theme
shoppex theme dev
shoppex theme dev reads .shoppex/theme.json, starts the local Liquid preview, and safely persists idle source changes with background theme push. Open the local URL printed by the command. Use live data instead of fixtures:
shoppex theme dev --shop-slug my-shop --no-msw

Minimal Files To Know

layout/theme.liquid
sections/*.liquid
snippets/*.liquid
assets/built.css
schema.json
settings.json
theme-package.json
The most important file is theme-package.json. It declares the entry template, sections, snippets, assets, settings files, and block registry. Undeclared templates are rejected.

Edit Loop

1

Edit Liquid or CSS

Change a section, snippet, layout, or CSS asset.
2

Refresh locally

The local dev server renders the theme with the same Liquid behavior used by Shoppex-hosted storefronts.
3

Validate

Run shoppex theme validate to catch missing files, unsafe Liquid, and package contract issues.
4

Preview

Use shoppex theme preview before publish.
5

Publish

Use shoppex theme publish only when the preview is correct.

Next Steps

Package Format

Learn the Liquid package contract.

Local Development

CLI sync, fixture data, live shop data, and common local setup issues.

Cart & Checkout

Wire product forms and checkout with platform-owned behavior.

Troubleshooting

Fix validation, rendering, and publish issues.