Sneferu theme SDK

Build themes for Hekana stores

Sneferu is Hekana's theme language and SDK: HTML with hk-* tags, template output and if, for and render directives, compiled to one safe artifact and previewed locally with sample data.

Quick start

1. 1

   Create a theme

   Copies the starter theme into a new folder and sets its id from the folder name.

   npx @hekana/sneferu init my-theme
2. 2

   Preview it

   Serves the theme on 127.0.0.1:4100 with sample data, Arabic first, and reloads on every save.

   npx @hekana/sneferu dev ./my-theme
3. 3

   Push a version

   Validates, compiles and uploads the theme. During the current phase, pushing is limited to Hekana platform admins.

   npx @hekana/sneferu push ./my-theme --package my-theme

The npm package is not published yet. Until it is, run the CLI from a clone of the SDK, as described in Getting started.

Guide

Eight chapters, from an empty folder to a published theme.

• Chapter 1Getting startedInstall, init, dev, validate and build.
• Chapter 2Theme structureEvery folder and file, theme.json and size limits.
• Chapter 3Sections and blockshk-schema, field types, settings coercion and blocks.
• Chapter 4Data and expressionsScope, lookups, filters, truthiness and loops.
• Chapter 5Styling and responsiveTokens, theme CSS, breakpoints and right-to-left.
• Chapter 6Security and limitsThe allow-list, URLs and render budgets.
• Chapter 7Publishingsneferu push, versions, install and publish.
• Chapter 8CookbookHero, pricing tiers, product grid and bento grid.

Reference

Every tag, every piece of syntax and every diagnostic code.

• Tag referenceEvery hk-* tag and its props.
• LanguageGrammar, directives, scope and filters.
• DiagnosticsEvery SN code and its fix.