Skip to content
Navigation

Primary

docara.json

docara.json is the settings file of the whole site. Only here do you set the content root, the base and public address, the language registry and the address rules, the documentation version, the redirects file, the reader panel, the Framework lock and the namespace of the project’s Smart components. The presentation, menu and reading fields set here serve as defaults for all pages.

How to read the field tables

The tables below are built at build time from the JSON Schema and the Docara code, so they include every docara.json field. The “Default” line under a description shows the value Docara uses when the field is not set. If there is no such line, there is no default: the field is required, or the feature is off without it. “Technical details” give the type, the validation rule and the place in the schema.

You can also set the presentation, menu and reading fields in section.json and <page>.page.json: see section.json and page.json. How levels and inheritance work is described in Site, section and page.

Basics

FieldWhat it does
/content_rootNo description yet.
Default: "content"
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/properties/content_root

/documentation_versionNo description yet.
Default: "current"
Technical details

Type: string · Level: site

Validation: pattern="^[A-Za-z0-9](?:[A-Za-z0-9._-]{0,62}[A-Za-z0-9])?$"

Schema: resources/schemas/site.schema.json#/properties/documentation_version

/framework_lock
required
No description yet.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/properties/framework_lock

/preset
required
No description yet.
Technical details

Type: string · Level: site

Validation: enum=["docs","landing"]

Schema: resources/schemas/site.schema.json#/properties/preset

/schema
required
No description yet.
Technical details

Type: string · Level: site

Validation: const="docara.site.v1"

Schema: resources/schemas/site.schema.json#/properties/schema

/titleNo description yet.
Default: "Docara"
Technical details

Type: string · Level: site

Validation: minLength=1

Schema: resources/schemas/site.schema.json#/properties/title

/versionNo description yet.
Technical details

Type: integer · Level: site

Validation: const=1

Schema: resources/schemas/site.schema.json#/properties/version

Address and publication

More in Site address and search engines.

FieldWhat it does
/base_urlNo description yet.
Default: "/"
Technical details

Type: string · Level: site

Validation: pattern="^(?:/|/(?!\\.{1,2}(?:/|$))[A-Za-z0-9._~-]+(?:/(?!\\.{1,2}(?:/|$))[A-Za-z0-9._~-]+)*/?)$"

Schema: resources/schemas/site.schema.json#/properties/base_url

/discoveryWhat llms.txt says about the site. Used only when site_url is set.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/properties/discovery

/discovery/descriptionNo description yet.
Technical details

Type: string · Level: site

Validation: minLength=1

Schema: resources/schemas/site.schema.json#/properties/discovery/properties/description

/discovery/llms_linksNo description yet.
Default: []
Technical details

Type: array · Level: site

Validation: maxItems=32

Schema: resources/schemas/site.schema.json#/properties/discovery/properties/llms_links

/discovery/llms_links/*No description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/properties/discovery/properties/llms_links/items

/discovery/llms_links/*/descriptionNo description yet.
Technical details

Type: string · Level: site

Validation: minLength=1

Schema: resources/schemas/site.schema.json#/properties/discovery/properties/llms_links/items/properties/description

/discovery/llms_links/*/path
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[A-Za-z0-9._~-]+(?:/[A-Za-z0-9._~-]+)*/?$"

Schema: resources/schemas/site.schema.json#/properties/discovery/properties/llms_links/items/properties/path

/discovery/llms_links/*/title
required
No description yet.
Technical details

Type: string · Level: site

Validation: minLength=1

Schema: resources/schemas/site.schema.json#/properties/discovery/properties/llms_links/items/properties/title

/not_foundThe 404.html page at the deployment base, in the default locale, with the site's header, navigation, search and theme. Built unless enabled is false. The content is the error.not_found.* strings of the default locale's lang.json (Docara has English and Russian ones), or the site's 404.md at the root of the default locale's content. The page is noindex and stays out of the navigation, search, sitemap.xml and llms.txt. A portal build has none: the portal owns 404.html, and enabled true there is an error.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/properties/not_found

/not_found/enabled
required
No description yet.
Default: true
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/site.schema.json#/properties/not_found/properties/enabled

/page_transformsCommands run over the written site before Docara measures it: each gets the site's directory as its last argument and runs in the project root; a failure fails the build.
Default: []
Technical details

Type: array · Level: site

Validation: maxItems=8

Schema: resources/schemas/site.schema.json#/properties/page_transforms

/page_transforms/*No description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/properties/page_transforms/items

/page_transforms/*/command
required
No description yet.
Technical details

Type: array · Level: site

Validation: minItems=1; maxItems=16

Schema: resources/schemas/site.schema.json#/properties/page_transforms/items/properties/command

/page_transforms/*/command/*No description yet.
Technical details

Type: string · Level: site

Validation: minLength=1

Schema: resources/schemas/site.schema.json#/properties/page_transforms/items/properties/command/items

/portalBuilds the site for one path of a portal, such as /ru/docara/docs/ on https://simai.io/. Needs site_url, one locale and locale_routing.strategy default_unprefixed. The build writes llms.txt but no sitemap.xml or robots.txt, refuses CNAME, .nojekyll, robots.txt, sitemap.xml and 404.html, and links back to home_url from the header. docara portal-artifact packs it.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/properties/portal

/portal/home_labelNo description yet.
Technical details

Type: string · Level: site

Validation: minLength=1; maxLength=80

Schema: resources/schemas/site.schema.json#/properties/portal/properties/home_label

/portal/home_url
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^https://[A-Za-z0-9](?:[A-Za-z0-9.-]*[A-Za-z0-9])?(?::[0-9]{1,5})?(?:/[A-Za-z0-9._~%-]*)*$"

Schema: resources/schemas/site.schema.json#/properties/portal/properties/home_url

/portal/product
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9-]{1,63}$"

Schema: resources/schemas/site.schema.json#/properties/portal/properties/product

/redirects_fileNo description yet.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/properties/redirects_file

/site_urlThe site's absolute public address: origin plus base_url, such as https://example.com/docs/. When set, the build writes sitemap.xml, robots.txt and llms.txt.
Technical details

Type: string · Level: site

Validation: pattern="^https?://[A-Za-z0-9.-]+(?::[0-9]{1,5})?(?:/|/[A-Za-z0-9._~-]+(?:/[A-Za-z0-9._~-]+)*/?)$"

Schema: resources/schemas/site.schema.json#/properties/site_url

Languages and translations

More in Multilingual site.

FieldWhat it does
/default_localeNo description yet.
Technical details

Type: string · Level: site

Validation: format="docara-bcp47"

Schema: resources/schemas/site.schema.json#/properties/default_locale

/localeNo description yet.
Technical details

Type: string · Level: site

Validation: format="docara-bcp47"

Schema: resources/schemas/site.schema.json#/properties/locale

/locale_routingNo description yet.
Default: {"strategy":"default_unprefixed","root":"default_locale","detect_browser_language":false,"legacy_unprefixed_redirects":false}
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/$defs/localeRouting

/locale_routing/detect_browser_language
required
No description yet.
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/site.schema.json#/$defs/localeRouting/properties/detect_browser_language

/locale_routing/legacy_unprefixed_redirectsNo description yet.
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/site.schema.json#/$defs/localeRouting/properties/legacy_unprefixed_redirects

/locale_routing/root
required
No description yet.
Technical details

Type: string · Level: site

Validation: enum=["default_locale","redirect"]

Schema: resources/schemas/site.schema.json#/$defs/localeRouting/properties/root

/locale_routing/strategy
required
No description yet.
Technical details

Type: string · Level: site

Validation: enum=["default_unprefixed","prefixed"]

Schema: resources/schemas/site.schema.json#/$defs/localeRouting/properties/strategy

/localesNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/site.schema.json#/properties/locales

/locales/<locale>No description yet.
Technical details

Path: /locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/$defs/locale

/locales/<locale>/content_root
required
No description yet.
Technical details

Path: /locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/content_root

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/$defs/locale/properties/content_root

/locales/<locale>/direction
required
No description yet.
Technical details

Path: /locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/direction

Type: string · Level: site

Validation: enum=["ltr","rtl"]

Schema: resources/schemas/site.schema.json#/$defs/locale/properties/direction

/locales/<locale>/fallbacksNo description yet.
Default: []
Technical details

Path: /locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/fallbacks

Type: array · Level: site

Validation: uniqueItems=true

Schema: resources/schemas/site.schema.json#/$defs/locale/properties/fallbacks

/locales/<locale>/fallbacks/*No description yet.
Technical details

Path: /locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/fallbacks/*

Type: string · Level: site

Validation: format="docara-bcp47"

Schema: resources/schemas/site.schema.json#/$defs/locale/properties/fallbacks/items

/locales/<locale>/label
required
No description yet.
Technical details

Path: /locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/label

Type: string · Level: site

Validation: minLength=1

Schema: resources/schemas/site.schema.json#/$defs/locale/properties/label

/locales/<locale>/public_prefixNo description yet.
Technical details

Path: /locales/<^(?!missing_page_policy$)[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*$>/public_prefix

Type: string · Level: site

Validation: pattern="^(?:|[A-Za-z0-9](?:[A-Za-z0-9._~-]*[A-Za-z0-9])?)$"

Schema: resources/schemas/site.schema.json#/$defs/locale/properties/public_prefix

/locales/missing_page_policyNo description yet.
Default: "skip"
Technical details

Type: string · Level: site

Validation: enum=["skip","error"]

Schema: resources/schemas/site.schema.json#/properties/locales/properties/missing_page_policy

/translation_trackingNo description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/$defs/translationTracking

/translation_tracking/enabled
required
No description yet.
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/site.schema.json#/$defs/translationTracking/properties/enabled

/translation_tracking/lock_file
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[A-Za-z0-9][A-Za-z0-9._-]*\\.json$"

Schema: resources/schemas/site.schema.json#/$defs/translationTracking/properties/lock_file

/translation_tracking/mode
required
No description yet.
Technical details

Type: string · Level: site

Validation: enum=["report","publish-current"]

Schema: resources/schemas/site.schema.json#/$defs/translationTracking/properties/mode

/translation_tracking/source_locale
required
No description yet.
Technical details

Type: string · Level: site

Validation: format="docara-bcp47"

Schema: resources/schemas/site.schema.json#/$defs/translationTracking/properties/source_locale

Appearance

More in Brand and theme and Layout regions.

FieldWhat it does
/brandingNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/branding

/branding/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/$reset

/branding/creditShow the "Made with Docara" line at the bottom of the left navigation. On by default; false removes it from every page. Site-wide: set it only in docara.json.
Default: true
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/credit

/branding/faviconNo description yet.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/favicon

/branding/labelNo description yet.
Technical details

Type: string · Level: site

Validation: minLength=1

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/label

/branding/logoNo description yet.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/logo

/branding/logo_darkNo description yet.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/logo_dark

/branding/modeNo description yet.
Default: "full"
Technical details

Type: string · Level: site

Validation: enum=["full","compact","logo","text"]

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/mode

/branding/share_imageThe picture shown when a page is shared (og:image, twitter:image): a PNG, JPEG or WebP file in the project. Used only when site_url is set.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/share_image

/branding/sizeNo description yet.
Default: "medium"
Technical details

Type: string · Level: site

Validation: enum=["small","medium","large"]

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/size

/branding/titleNo description yet.
Technical details

Type: string · Level: site

Validation: minLength=1

Schema: resources/schemas/presentation.schema.json#/$defs/branding/properties/title

/effectsThe SIMAI Framework background effects catalogue (SF.Effects) that hero effects load from. Written to SF_BOOT_CONFIG.effects. Pin catalogue to a commit. Needs a Framework pair with SF.Effects (ui-08c07b3e938a or later).
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/properties/effects

/effects/catalogue
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^https://[A-Za-z0-9](?:[A-Za-z0-9.-]*[A-Za-z0-9])?(?::[0-9]{1,5})?/(?:[A-Za-z0-9._~%@+-]+/)*$"

Schema: resources/schemas/site.schema.json#/properties/effects/properties/catalogue

/effects/indexNo description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[A-Za-z0-9._-]+(?:/[A-Za-z0-9._-]+)*\\.json$"

Schema: resources/schemas/site.schema.json#/properties/effects/properties/index

/effects/index_sha256No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[0-9a-f]{64}$"

Schema: resources/schemas/site.schema.json#/properties/effects/properties/index_sha256

/layoutNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/layout

/layout/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/layout/properties/$reset

/layout/containerNo description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/layout/properties/container

/layout/container/max
required
No description yet.
Default: 7
Technical details

Type: integer · Level: site

Validation: minimum=1; maximum=8

Schema: resources/schemas/presentation.schema.json#/$defs/layout/properties/container/properties/max

/layout/contentNo description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/layout/properties/content

/layout/content/gap
required
No description yet.
Default: null
Technical details

Type: integer · Level: site

Validation: minimum=0; maximum=8

Schema: resources/schemas/presentation.schema.json#/$defs/layout/properties/content/properties/gap

/layout/keyNo description yet.
Default: "docara.docs"
Technical details

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/layout/properties/key

/layout/regionsNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/regions

/layout/regions/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/regions/properties/$reset

/layout/regions/<region>No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/region

/layout/regions/<region>/$resetNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/$reset

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/region/properties/$reset

/layout/regions/<region>/enabledNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/enabled

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/region/properties/enabled

/layout/regions/<region>/sectionsNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections

Type: array · Level: site

Validation: maxItems=8

Schema: resources/schemas/presentation.schema.json#/$defs/region/properties/sections

/layout/regions/<region>/sections/*No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/region_section

/layout/regions/<region>/sections/*/blocksNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks

Type: array · Level: site

Validation: minItems=1; maxItems=12

Schema: resources/schemas/presentation.schema.json#/$defs/region_section/properties/blocks

/layout/regions/<region>/sections/*/blocks/*No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*

Type: oneOf · Level: site

Validation: oneOf=3

Schema: resources/schemas/presentation.schema.json#/$defs/region_block

/layout/regions/<region>/sections/*/blocks/*/bindNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/bind

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9-]*\\.[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/bind

/layout/regions/<region>/sections/*/blocks/*/block
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/block

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/block

/layout/regions/<region>/sections/*/blocks/*/block
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/block

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/block

/layout/regions/<region>/sections/*/blocks/*/block
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/block

Type: string · Level: site

Validation: const="shell.set-passport"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/2/properties/block

/layout/regions/<region>/sections/*/blocks/*/element
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element

/layout/regions/<region>/sections/*/blocks/*/element/aria_labelNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/aria_label

Type: string · Level: site

Validation: minLength=1; maxLength=160

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/aria_label

/layout/regions/<region>/sections/*/blocks/*/element/hrefNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/href

Type: string · Level: site

Validation: pattern="^(?:/|[/#][^\\u0000-\\u0020\\\"'<>\\\\]+)$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/href

/layout/regions/<region>/sections/*/blocks/*/element/tag
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/tag

Type: string · Level: site

Validation: enum=["div","p","span","a"]

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/tag

/layout/regions/<region>/sections/*/blocks/*/element/text
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/text

Type: string · Level: site

Validation: minLength=1; maxLength=500

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/text

/layout/regions/<region>/sections/*/blocks/*/element/utilitiesNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/utilities

Type: array · Level: site

Validation: maxItems=16; uniqueItems=true

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/utilities

/layout/regions/<region>/sections/*/blocks/*/element/utilities/*No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/element/utilities/*

Type: string · Level: site

Validation: pattern="^[a-z0-9][a-z0-9_:/.-]*$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/element/properties/utilities/items

/layout/regions/<region>/sections/*/blocks/*/historyNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/history

Type: string · Level: site

Validation: pattern="^(?:/(?!/)|https://)[^\\u0000-\\u0020\\\"'<>\\\\]*$"; maxLength=500

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/2/properties/history

/layout/regions/<region>/sections/*/blocks/*/id
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/id

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/id

/layout/regions/<region>/sections/*/blocks/*/id
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/id

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/id

/layout/regions/<region>/sections/*/blocks/*/id
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/id

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/2/properties/id

/layout/regions/<region>/sections/*/blocks/*/package
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/package

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9-]*$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/2/properties/package

/layout/regions/<region>/sections/*/blocks/*/props
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/props

Type: object · Level: site

Validation: maxProperties=32

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/props

/layout/regions/<region>/sections/*/blocks/*/slot
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/slot

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/0/properties/slot

/layout/regions/<region>/sections/*/blocks/*/slot
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/slot

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/slot

/layout/regions/<region>/sections/*/blocks/*/slot
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/slot

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/2/properties/slot

/layout/regions/<region>/sections/*/blocks/*/smart
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/smart

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/smart

/layout/regions/<region>/sections/*/blocks/*/viewNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/blocks/*/view

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_block/oneOf/1/properties/view

/layout/regions/<region>/sections/*/id
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/id

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_section/properties/id

/layout/regions/<region>/sections/*/section
required
No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/section

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]+$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_section/properties/section

/layout/regions/<region>/sections/*/utilitiesNo description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/utilities

Type: array · Level: site

Validation: maxItems=16; uniqueItems=true

Schema: resources/schemas/presentation.schema.json#/$defs/region_section/properties/utilities

/layout/regions/<region>/sections/*/utilities/*No description yet.
Technical details

Path: /layout/regions/<^[a-z][a-z0-9_.-]+$>/sections/*/utilities/*

Type: string · Level: site

Validation: pattern="^[a-z0-9][a-z0-9_:/.-]*$"

Schema: resources/schemas/presentation.schema.json#/$defs/region_section/properties/utilities/items

/layout/scrollbarNo description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar

/layout/scrollbar/preset
required
No description yet.
Default: "overlay"
Technical details

Type: string · Level: site

Validation: enum=["overlay","persistent","standard","hidden"]

Schema: resources/schemas/presentation.schema.json#/$defs/layout/properties/scrollbar/properties/preset

/settingsNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/settings

/settings/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/settings/properties/$reset

/settings/modal_blurNo description yet.
Default: "none"
Technical details

Type: string · Level: site

Validation: enum=["none","small","medium","large"]

Schema: resources/schemas/presentation.schema.json#/$defs/settings/properties/modal_blur

/settings/themeNo description yet.
Default: "system"
Technical details

Type: string · Level: site

Validation: enum=["system","light","dark"]

Schema: resources/schemas/presentation.schema.json#/$defs/settings/properties/theme

/settings/ui_radiusNo description yet.
Default: "default"
Technical details

Type: string · Level: site

Validation: enum=["default","medium","large"]

Schema: resources/schemas/presentation.schema.json#/$defs/settings/properties/ui_radius

/themeThe site's colours from one main colour: color is a hex colour, #rgb or #rrggbb; hue (0-360) and chroma (0-150) override how the colour is read.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/properties/theme

/theme/chromaNo description yet.
Technical details

Type: integer · Level: site

Validation: minimum=0; maximum=150

Schema: resources/schemas/site.schema.json#/properties/theme/properties/chroma

/theme/color
required
No description yet.
Technical details

Type: string · Level: site

Validation: minLength=1

Schema: resources/schemas/site.schema.json#/properties/theme/properties/color

/theme/hueNo description yet.
Technical details

Type: integer · Level: site

Validation: minimum=0; maximum=360

Schema: resources/schemas/site.schema.json#/properties/theme/properties/hue

More in Menu and sections, Reading context, Search and Reader panel.

FieldWhat it does
/header_navigationNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false; allOf=1

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation

/header_navigation/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/$reset

/header_navigation/enabledNo description yet.
Default: false
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/enabled

/header_navigation/enabled
required
No description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/allOf/0/if/properties/enabled

/header_navigation/itemsNo description yet.
Technical details

Type: array · Level: site

Validation: minItems=1; maxItems=8

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items

/header_navigation/items/*No description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items

/header_navigation/items/*/href
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^(?:#(?!$)|/(?!/)|https://)[^\\x{0000}-\\x{0020}\\\"'<>\\\\]+$"; maxLength=2000

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/href

/header_navigation/items/*/id
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9_.-]{0,63}$"

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/id

/header_navigation/items/*/label
required
No description yet.
Technical details

Type: string · Level: site

Validation: minLength=1; maxLength=80

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/label

/header_navigation/items/*/sectionsNo description yet.
Technical details

Type: array · Level: site

Validation: minItems=1; maxItems=16; uniqueItems=true

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/sections

/header_navigation/items/*/sections/*No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^/(?!/)[^\\x{0000}-\\x{0020}\\\"'<>\\\\#?]*$"; maxLength=2000

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/items/items/properties/sections/items

/header_navigation/repositoryNo description yet.
Technical details

Type: string · Level: site

Validation: pattern="^https://[^\\x{0000}-\\x{0020}\\\"'<>\\\\]+$"; maxLength=2000

Schema: resources/schemas/presentation.schema.json#/$defs/header_navigation/properties/repository

/navigationNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/navigation

/navigation/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/navigation/properties/$reset

/navigation/hiddenNo description yet.
Default: false
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/navigation/properties/hidden

/navigation/orderNo description yet.
Technical details

Type: integer · Level: site

Validation: minimum=0; maximum=2147483647

Schema: resources/schemas/presentation.schema.json#/$defs/navigation/properties/order

/navigation/scopeNo description yet.
Default: "site"
Technical details

Type: string · Level: site

Validation: enum=["site","section"]

Schema: resources/schemas/presentation.schema.json#/$defs/navigation/properties/scope

/reader_preferencesNo description yet.
Default: {"enabled":true,"view":"menu","groups":[{"id":"appearance","fields":["appearance.theme","appearance.font_size","appearance.content_width"]}]}
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences

/reader_preferences/enabled
required
No description yet.
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences/properties/enabled

/reader_preferences/groups
required
No description yet.
Technical details

Type: array · Level: site

Validation: maxItems=20; uniqueItems=true

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups

/reader_preferences/groups/*No description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups/items

/reader_preferences/groups/*/fields
required
No description yet.
Technical details

Type: array · Level: site

Validation: minItems=1; maxItems=50; uniqueItems=true

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups/items/properties/fields

/reader_preferences/groups/*/fields/*No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9]*(?:[._-][a-z0-9]+)*$"; maxLength=120

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups/items/properties/fields/items

/reader_preferences/groups/*/id
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9]*(?:[._-][a-z0-9]+)*$"; maxLength=80

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences/properties/groups/items/properties/id

/reader_preferences/hidden_fieldsNo description yet.
Default: []
Technical details

Type: array · Level: site

Validation: maxItems=50; uniqueItems=true

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences/properties/hidden_fields

/reader_preferences/hidden_fields/*No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9]*(?:[._-][a-z0-9]+)*$"; maxLength=120

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences/properties/hidden_fields/items

/reader_preferences/view
required
No description yet.
Technical details

Type: string · Level: site

Validation: enum=["menu","side-panel"]

Schema: resources/schemas/site.schema.json#/$defs/readerPreferences/properties/view

/readingNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/reading

/reading/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/reading/properties/$reset

/reading/breadcrumbsNo description yet.
Default: true
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/reading/properties/breadcrumbs

/reading/mobile_tocNo description yet.
Default: "auto"
Technical details

Type: string · Level: site

Validation: enum=["auto","always","never"]

Schema: resources/schemas/presentation.schema.json#/$defs/reading/properties/mobile_toc

/reading/previous_nextNo description yet.
Default: true
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/reading/properties/previous_next

/reading/tocNo description yet.
Default: true
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/reading/properties/toc

/reading/toc_depthNo description yet.
Default: 3
Technical details

Type: integer · Level: site

Validation: minimum=2; maximum=6

Schema: resources/schemas/presentation.schema.json#/$defs/reading/properties/toc_depth

/searchNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/search

/search/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/search/properties/$reset

/search/enabledNo description yet.
Default: false
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/search/properties/enabled

/search/indexedNo description yet.
Default: true
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/search/properties/indexed

Examples, code and extensions

FieldWhat it does
/codeNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/code

/code/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/code/properties/$reset

/code/wrapNo description yet.
Default: true
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/code/properties/wrap

/documentation_trackingNo description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/$defs/documentationTracking

/documentation_tracking/enabled
required
No description yet.
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/site.schema.json#/$defs/documentationTracking/properties/enabled

/documentation_tracking/lock_file
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[A-Za-z0-9][A-Za-z0-9._-]*\\.json$"

Schema: resources/schemas/site.schema.json#/$defs/documentationTracking/properties/lock_file

/documentation_tracking/mode
required
No description yet.
Technical details

Type: string · Level: site

Validation: const="report"

Schema: resources/schemas/site.schema.json#/$defs/documentationTracking/properties/mode

/documentation_tracking/source_locale
required
No description yet.
Technical details

Type: string · Level: site

Validation: format="docara-bcp47"

Schema: resources/schemas/site.schema.json#/$defs/documentationTracking/properties/source_locale

/documentation_tracking/sources
required
No description yet.
Technical details

Type: array · Level: site

Validation: minItems=1

Schema: resources/schemas/site.schema.json#/$defs/documentationTracking/properties/sources

/documentation_tracking/sources/*No description yet.
Technical details

Type: oneOf · Level: site

Validation: oneOf=2

Schema: resources/schemas/site.schema.json#/$defs/documentationSource

/documentation_tracking/sources/*/file
required
No description yet.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/1/properties/file

/documentation_tracking/sources/*/framework_lock
required
No description yet.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/0/properties/framework_lock

/documentation_tracking/sources/*/id
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9-]*$"

Schema: resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/0/properties/id

/documentation_tracking/sources/*/id
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^[a-z][a-z0-9-]*$"

Schema: resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/1/properties/id

/documentation_tracking/sources/*/linkageFramework linkage (standard simai.linkage): the unit inventories, change reports and change journal the site keeps, so docara documentation linkage and the build report which pages describe units that changed.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/$defs/documentationLinkage

/documentation_tracking/sources/*/linkage/brought_up_onThe day the pages were brought up to since; journal records without a unit version count when recorded later.
Technical details

Type: string · Level: site

Validation: pattern="^[0-9]{4}-[0-9]{2}-[0-9]{2}$"

Schema: resources/schemas/site.schema.json#/$defs/documentationLinkage/properties/brought_up_on

/documentation_tracking/sources/*/linkage/changessimai.framework.unit-change-report files between since and inventory.
Technical details

Type: array · Level: site

Validation: schema type only

Schema: resources/schemas/site.schema.json#/$defs/documentationLinkage/properties/changes

/documentation_tracking/sources/*/linkage/changes/*No description yet.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/$defs/documentationLinkage/properties/changes/items

/documentation_tracking/sources/*/linkage/inventory
required
The simai.framework.unit-inventory of the release the site builds against.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/$defs/documentationLinkage/properties/inventory

/documentation_tracking/sources/*/linkage/journalThe simai.change-journal whose instructions are quoted.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/$defs/documentationLinkage/properties/journal

/documentation_tracking/sources/*/linkage/sinceThe inventory of the release the pages were last brought up to; required unless usage is given.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/$defs/documentationLinkage/properties/since

/documentation_tracking/sources/*/linkage/usageA hand-kept simai.framework.unit-usage record used instead of the one derived from the documentation lock.
Technical details

Type: string · Level: site

Validation: format="docara-relative-path"

Schema: resources/schemas/site.schema.json#/$defs/documentationLinkage/properties/usage

/documentation_tracking/sources/*/provider
required
No description yet.
Technical details

Type: string · Level: site

Validation: const="simai_framework"

Schema: resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/0/properties/provider

/documentation_tracking/sources/*/provider
required
No description yet.
Technical details

Type: string · Level: site

Validation: const="contract_json"

Schema: resources/schemas/site.schema.json#/$defs/documentationSource/oneOf/1/properties/provider

/examplesNo description yet.
Technical details

Type: object · Level: site

Validation: minProperties=1; additionalProperties=false

Schema: resources/schemas/presentation.schema.json#/$defs/examples

/examples/$resetNo description yet.
Technical details

Type: bool · Level: site

Validation: const=true

Schema: resources/schemas/presentation.schema.json#/$defs/examples/properties/$reset

/examples/fullscreenNo description yet.
Default: true
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/examples/properties/fullscreen

/examples/wrapNo description yet.
Default: true
Technical details

Type: boolean · Level: site

Validation: schema type only

Schema: resources/schemas/presentation.schema.json#/$defs/examples/properties/wrap

/smartNo description yet.
Technical details

Type: object · Level: site

Validation: additionalProperties=false

Schema: resources/schemas/site.schema.json#/$defs/projectSmart

/smart/namespace
required
No description yet.
Technical details

Type: string · Level: site

Validation: pattern="^(?!ui$|docara$)[a-z][a-z0-9-]*$"

Schema: resources/schemas/site.schema.json#/$defs/projectSmart/properties/namespace