Skip to main content
demo.config.json is the source file for one interactive demo. It describes the story a viewer sees: the screens, messages, cover pages, forms, captions, and buttons. Most teams edit this visually in Inkly or with an AI agent. Use this reference when you want to understand what those tools save in the repo. 
{
  "id": "k3Bq-7Zr_a1X",
  "version": 1,
  "title": "Onboarding tour",
  "chapters": [
    { "id": "intro", "title": "Get started", "stepIds": ["cover", "s1"] }
  ],
  "steps": []
}

Top-level fields

Configure demo identity, visibility, chrome, background, theme, and aspect ratio.

Content steps

Define product screens, media backgrounds, zoom, narration, and captions.

Annotations

Add messages, blur masks, and text labels over content steps.

Cover steps

Add intro, transition, closing, lead-capture, and embedded-content screens.

Widgets

Configure headline, form, embed, custom, and image widgets for cover steps.

Navigation and actions

Define chapters, captions, CTAs, and button destinations.

​
File location

A hub stores demos under demos/<slug>/. Each demo folder has a demo.config.json file and may also include assets.json, public/, and snapshots/. 
demos/
  onboarding/
    demo.config.json
    assets.json
    public/
    snapshots/
For managed media references, see Assets.