inkly.json - Inkly

inkly.json is the main settings file for a demo hub. It names the hub, chooses the layout, sets hero copy, points to brand settings, and lists the demo collections shown to visitors. You usually change these settings in Inkly’s hub settings page or through an agent. This page shows what gets saved in the repo.

{
  "$schema": "https://inklyai.dev/inkly.json",
  "name": "Inkly AI Demos",
  "runtime": "0.6.2",
  "runtimeRange": "^0.6.2",
  "theme": "inkly",
  "collections": [
    {
      "name": "Main",
      "description": "The first set of demos for this hub.",
      "demos": ["getting-started"]
    }
  ]
}

Fields

Field	Type	Required	Default	Notes
`$schema`	`string`	No	—	Optional JSON Schema URL for editor tooling.
`name`	`string`	Yes	—	Hub name. Must be non-empty.
`runtime`	`string`	Yes	—	Exact semver pin, for example `0.6.2`. Must be an exact version, not a range.
`runtimeRange`	`string`	No	—	Optional semver range, for example `^0.6.2`, describing compatible runtime versions.
`layout`	`"sidebar"` \| `"tabs"`	No	`"tabs"`	Hub-index chrome.
`theme`	`string`	No	`"inkly"`	Theme preset id. Platform surfaces default an omitted theme to `"inkly"`.
`tokens`	`object`	No	—	Overrides the preset’s token defaults. See Theme tokens.
`brand`	`object`	No	—	Hub logo, favicon, and CTAs. See Branding.
`title`	`string`	No	—	Hub-index hero title. Wrap a span in asterisks, such as `faster.`, to render it as the italic accent.
`subtitle`	`string`	No	—	Hub-index hero subtitle, plain text.
`collections`	`object[]`	No	—	Named groupings of demo slugs surfaced on the hub index. See Collections.

Runtime fields

The runtime fields tell Inkly which viewer version should render the hub. In normal authoring, you rarely edit these by hand. Use Runtime lock for the resolved lock-file shape.

​Fields

​Runtime fields

Fields

Runtime fields