Skip to content
Navigation

Primary

section.json and page.json

section.json configures a section: the overview page beside it and all pages of the folder. <page>.page.json refines one page and also sets its description and slug. How levels are inherited and reset is described in Site, section and page.

How to read the field tables

The tables are built at build time from the JSON Schema. If a field is not set in the file, the value from the level above applies: from the nearest section.json of a parent folder or from docara.json. The “Default” line under a description shows the built-in Docara value when the field is set nowhere. “Technical details” give the type, the validation rule and the place in the schema.

section.json

Basics

FieldWhat it does
/localeNo description yet.
Technical details

Type: string · Level: section

Validation: format="docara-bcp47"

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

/presetNo description yet.
Technical details

Type: string · Level: section

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

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

/schema
required
No description yet.
Technical details

Type: string · Level: section

Validation: const="docara.section.v1"

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

/titleNo description yet.
Technical details

Type: string · Level: section

Validation: minLength=1

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

/versionNo description yet.
Technical details

Type: integer · Level: section

Validation: const=1

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

Appearance

FieldWhat it does
/brandingNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: minProperties=1; additionalProperties=false

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

/branding/$resetNo description yet.
Technical details

Type: bool · Level: section

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: inherited; otherwise true
Technical details

Type: boolean · Level: section

Validation: schema type only

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

/branding/faviconNo description yet.
Default: inherited
Technical details

Type: string · Level: section

Validation: format="docara-relative-path"

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

/branding/labelNo description yet.
Default: inherited
Technical details

Type: string · Level: section

Validation: minLength=1

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

/branding/logoNo description yet.
Default: inherited
Technical details

Type: string · Level: section

Validation: format="docara-relative-path"

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

/branding/logo_darkNo description yet.
Default: inherited
Technical details

Type: string · Level: section

Validation: format="docara-relative-path"

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

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

Type: string · Level: section

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.
Default: inherited
Technical details

Type: string · Level: section

Validation: format="docara-relative-path"

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

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

Type: string · Level: section

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

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

/branding/titleNo description yet.
Default: inherited
Technical details

Type: string · Level: section

Validation: minLength=1

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

/layoutNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: minProperties=1; additionalProperties=false

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

/layout/$resetNo description yet.
Technical details

Type: bool · Level: section

Validation: const=true

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

/layout/containerNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: additionalProperties=false

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

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

Type: integer · Level: section

Validation: minimum=1; maximum=8

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

/layout/contentNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: additionalProperties=false

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

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

Type: integer · Level: section

Validation: minimum=0; maximum=8

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

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

Type: string · Level: section

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

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

/layout/regionsNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: minProperties=1; additionalProperties=false

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

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

Type: bool · Level: section

Validation: const=true

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

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

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

Type: object · Level: section

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: section

Validation: const=true

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

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

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

Type: boolean · Level: section

Validation: schema type only

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

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

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

Type: array · Level: section

Validation: maxItems=8

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

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

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

Type: object · Level: section

Validation: additionalProperties=false

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

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

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

Type: array · Level: section

Validation: minItems=1; maxItems=12

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

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

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

Type: oneOf · Level: section

Validation: oneOf=3

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

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

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: object · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: array · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: object · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: string · Level: section

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.
Default: inherited
Technical details

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

Type: array · Level: section

Validation: maxItems=16; uniqueItems=true

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

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

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

Type: string · Level: section

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

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

/layout/scrollbarNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: additionalProperties=false

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

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

Type: string · Level: section

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

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

/settingsNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: minProperties=1; additionalProperties=false

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

/settings/$resetNo description yet.
Technical details

Type: bool · Level: section

Validation: const=true

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

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

Type: string · Level: section

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

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

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

Type: string · Level: section

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

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

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

Type: string · Level: section

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

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

FieldWhat it does
/header_navigationNo description yet.
Default: inherited
Technical details

Type: object · Level: section

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: section

Validation: const=true

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

/header_navigation/enabledNo description yet.
Default: inherited; otherwise false
Technical details

Type: boolean · Level: section

Validation: schema type only

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

/header_navigation/enabled
required
No description yet.
Default: inherited
Technical details

Type: bool · Level: section

Validation: const=true

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

/header_navigation/itemsNo description yet.
Default: inherited
Technical details

Type: array · Level: section

Validation: minItems=1; maxItems=8

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

/header_navigation/items/*No description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: additionalProperties=false

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

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

Type: string · Level: section

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.
Default: inherited
Technical details

Type: string · Level: section

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.
Default: inherited
Technical details

Type: string · Level: section

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.
Default: inherited
Technical details

Type: array · Level: section

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.
Default: inherited
Technical details

Type: string · Level: section

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.
Default: inherited
Technical details

Type: string · Level: section

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

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

/navigationNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: minProperties=1; additionalProperties=false

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

/navigation/$resetNo description yet.
Technical details

Type: bool · Level: section

Validation: const=true

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

/navigation/hiddenNo description yet.
Default: inherited; otherwise false
Technical details

Type: boolean · Level: section

Validation: schema type only

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

/navigation/orderNo description yet.
Default: inherited
Technical details

Type: integer · Level: section

Validation: minimum=0; maximum=2147483647

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

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

Type: string · Level: section

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

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

/readingNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: minProperties=1; additionalProperties=false

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

/reading/$resetNo description yet.
Technical details

Type: bool · Level: section

Validation: const=true

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

/reading/breadcrumbsNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: section

Validation: schema type only

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

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

Type: string · Level: section

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

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

/reading/previous_nextNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: section

Validation: schema type only

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

/reading/tocNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: section

Validation: schema type only

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

/reading/toc_depthNo description yet.
Default: inherited; otherwise 3
Technical details

Type: integer · Level: section

Validation: minimum=2; maximum=6

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

/searchNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: minProperties=1; additionalProperties=false

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

/search/$resetNo description yet.
Technical details

Type: bool · Level: section

Validation: const=true

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

/search/enabledNo description yet.
Default: inherited; otherwise false
Technical details

Type: boolean · Level: section

Validation: schema type only

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

/search/indexedNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: section

Validation: schema type only

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

Examples and code

FieldWhat it does
/codeNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: minProperties=1; additionalProperties=false

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

/code/$resetNo description yet.
Technical details

Type: bool · Level: section

Validation: const=true

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

/code/wrapNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: section

Validation: schema type only

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

/examplesNo description yet.
Default: inherited
Technical details

Type: object · Level: section

Validation: minProperties=1; additionalProperties=false

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

/examples/$resetNo description yet.
Technical details

Type: bool · Level: section

Validation: const=true

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

/examples/fullscreenNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: section

Validation: schema type only

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

/examples/wrapNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: section

Validation: schema type only

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

page.json

Basics

FieldWhat it does
/descriptionNo description yet.
Technical details

Type: string · Level: page

Validation: schema type only

Schema: resources/schemas/page.schema.json#/properties/description

/localeNo description yet.
Technical details

Type: string · Level: page

Validation: format="docara-bcp47"

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

/presetNo description yet.
Technical details

Type: string · Level: page

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

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

/schema
required
No description yet.
Technical details

Type: string · Level: page

Validation: const="docara.page.v1"

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

/slugNo description yet.
Technical details

Type: string · Level: page

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

Schema: resources/schemas/page.schema.json#/properties/slug

/titleNo description yet.
Technical details

Type: string · Level: page

Validation: minLength=1

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

/versionNo description yet.
Technical details

Type: integer · Level: page

Validation: const=1

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

Appearance

FieldWhat it does
/brandingNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: minProperties=1; additionalProperties=false

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

/branding/$resetNo description yet.
Technical details

Type: bool · Level: page

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: inherited; otherwise true
Technical details

Type: boolean · Level: page

Validation: schema type only

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

/branding/faviconNo description yet.
Default: inherited
Technical details

Type: string · Level: page

Validation: format="docara-relative-path"

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

/branding/labelNo description yet.
Default: inherited
Technical details

Type: string · Level: page

Validation: minLength=1

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

/branding/logoNo description yet.
Default: inherited
Technical details

Type: string · Level: page

Validation: format="docara-relative-path"

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

/branding/logo_darkNo description yet.
Default: inherited
Technical details

Type: string · Level: page

Validation: format="docara-relative-path"

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

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

Type: string · Level: page

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.
Default: inherited
Technical details

Type: string · Level: page

Validation: format="docara-relative-path"

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

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

Type: string · Level: page

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

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

/branding/titleNo description yet.
Default: inherited
Technical details

Type: string · Level: page

Validation: minLength=1

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

/layoutNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: minProperties=1; additionalProperties=false

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

/layout/$resetNo description yet.
Technical details

Type: bool · Level: page

Validation: const=true

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

/layout/containerNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: additionalProperties=false

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

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

Type: integer · Level: page

Validation: minimum=1; maximum=8

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

/layout/contentNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: additionalProperties=false

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

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

Type: integer · Level: page

Validation: minimum=0; maximum=8

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

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

Type: string · Level: page

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

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

/layout/regionsNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: minProperties=1; additionalProperties=false

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

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

Type: bool · Level: page

Validation: const=true

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

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

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

Type: object · Level: page

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: page

Validation: const=true

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

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

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

Type: boolean · Level: page

Validation: schema type only

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

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

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

Type: array · Level: page

Validation: maxItems=8

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

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

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

Type: object · Level: page

Validation: additionalProperties=false

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

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

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

Type: array · Level: page

Validation: minItems=1; maxItems=12

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

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

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

Type: oneOf · Level: page

Validation: oneOf=3

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

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

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: object · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: array · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: object · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: string · Level: page

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.
Default: inherited
Technical details

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

Type: array · Level: page

Validation: maxItems=16; uniqueItems=true

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

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

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

Type: string · Level: page

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

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

/layout/scrollbarNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: additionalProperties=false

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

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

Type: string · Level: page

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

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

/settingsNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: minProperties=1; additionalProperties=false

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

/settings/$resetNo description yet.
Technical details

Type: bool · Level: page

Validation: const=true

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

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

Type: string · Level: page

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

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

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

Type: string · Level: page

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

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

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

Type: string · Level: page

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

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

FieldWhat it does
/header_navigationNo description yet.
Default: inherited
Technical details

Type: object · Level: page

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: page

Validation: const=true

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

/header_navigation/enabledNo description yet.
Default: inherited; otherwise false
Technical details

Type: boolean · Level: page

Validation: schema type only

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

/header_navigation/enabled
required
No description yet.
Default: inherited
Technical details

Type: bool · Level: page

Validation: const=true

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

/header_navigation/itemsNo description yet.
Default: inherited
Technical details

Type: array · Level: page

Validation: minItems=1; maxItems=8

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

/header_navigation/items/*No description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: additionalProperties=false

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

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

Type: string · Level: page

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.
Default: inherited
Technical details

Type: string · Level: page

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.
Default: inherited
Technical details

Type: string · Level: page

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.
Default: inherited
Technical details

Type: array · Level: page

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.
Default: inherited
Technical details

Type: string · Level: page

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.
Default: inherited
Technical details

Type: string · Level: page

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

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

/navigationNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: minProperties=1; additionalProperties=false

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

/navigation/$resetNo description yet.
Technical details

Type: bool · Level: page

Validation: const=true

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

/navigation/hiddenNo description yet.
Default: inherited; otherwise false
Technical details

Type: boolean · Level: page

Validation: schema type only

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

/navigation/orderNo description yet.
Default: inherited
Technical details

Type: integer · Level: page

Validation: minimum=0; maximum=2147483647

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

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

Type: string · Level: page

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

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

/readingNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: minProperties=1; additionalProperties=false

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

/reading/$resetNo description yet.
Technical details

Type: bool · Level: page

Validation: const=true

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

/reading/breadcrumbsNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: page

Validation: schema type only

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

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

Type: string · Level: page

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

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

/reading/previous_nextNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: page

Validation: schema type only

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

/reading/tocNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: page

Validation: schema type only

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

/reading/toc_depthNo description yet.
Default: inherited; otherwise 3
Technical details

Type: integer · Level: page

Validation: minimum=2; maximum=6

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

/searchNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: minProperties=1; additionalProperties=false

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

/search/$resetNo description yet.
Technical details

Type: bool · Level: page

Validation: const=true

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

/search/enabledNo description yet.
Default: inherited; otherwise false
Technical details

Type: boolean · Level: page

Validation: schema type only

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

/search/indexedNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: page

Validation: schema type only

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

Examples and code

FieldWhat it does
/codeNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: minProperties=1; additionalProperties=false

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

/code/$resetNo description yet.
Technical details

Type: bool · Level: page

Validation: const=true

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

/code/wrapNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: page

Validation: schema type only

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

/examplesNo description yet.
Default: inherited
Technical details

Type: object · Level: page

Validation: minProperties=1; additionalProperties=false

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

/examples/$resetNo description yet.
Technical details

Type: bool · Level: page

Validation: const=true

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

/examples/fullscreenNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: page

Validation: schema type only

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

/examples/wrapNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: page

Validation: schema type only

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

Shared presentation fields

These branches are the same on all three levels. The table is built from presentation.schema.json.

FieldWhat it does
/brandingNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: minProperties=1; additionalProperties=false

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

/branding/$resetNo description yet.
Technical details

Type: bool · Level: shared

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: inherited; otherwise true
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/branding/faviconNo description yet.
Default: inherited
Technical details

Type: string · Level: shared

Validation: format="docara-relative-path"

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

/branding/labelNo description yet.
Default: inherited
Technical details

Type: string · Level: shared

Validation: minLength=1

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

/branding/logoNo description yet.
Default: inherited
Technical details

Type: string · Level: shared

Validation: format="docara-relative-path"

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

/branding/logo_darkNo description yet.
Default: inherited
Technical details

Type: string · Level: shared

Validation: format="docara-relative-path"

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

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

Type: string · Level: shared

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.
Default: inherited
Technical details

Type: string · Level: shared

Validation: format="docara-relative-path"

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

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

Type: string · Level: shared

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

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

/branding/titleNo description yet.
Default: inherited
Technical details

Type: string · Level: shared

Validation: minLength=1

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

/codeNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: minProperties=1; additionalProperties=false

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

/code/$resetNo description yet.
Technical details

Type: bool · Level: shared

Validation: const=true

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

/code/wrapNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/examplesNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: minProperties=1; additionalProperties=false

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

/examples/$resetNo description yet.
Technical details

Type: bool · Level: shared

Validation: const=true

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

/examples/fullscreenNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/examples/wrapNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/header_navigationNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

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: shared

Validation: const=true

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

/header_navigation/enabledNo description yet.
Default: inherited; otherwise false
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/header_navigation/enabled
required
No description yet.
Default: inherited
Technical details

Type: bool · Level: shared

Validation: const=true

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

/header_navigation/itemsNo description yet.
Default: inherited
Technical details

Type: array · Level: shared

Validation: minItems=1; maxItems=8

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

/header_navigation/items/*No description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: additionalProperties=false

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

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

Type: string · Level: shared

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.
Default: inherited
Technical details

Type: string · Level: shared

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.
Default: inherited
Technical details

Type: string · Level: shared

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.
Default: inherited
Technical details

Type: array · Level: shared

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.
Default: inherited
Technical details

Type: string · Level: shared

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.
Default: inherited
Technical details

Type: string · Level: shared

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

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

/layoutNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: minProperties=1; additionalProperties=false

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

/layout/$resetNo description yet.
Technical details

Type: bool · Level: shared

Validation: const=true

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

/layout/containerNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: additionalProperties=false

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

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

Type: integer · Level: shared

Validation: minimum=1; maximum=8

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

/layout/contentNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: additionalProperties=false

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

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

Type: integer · Level: shared

Validation: minimum=0; maximum=8

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

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

Type: string · Level: shared

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

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

/layout/regionsNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: minProperties=1; additionalProperties=false

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

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

Type: bool · Level: shared

Validation: const=true

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

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

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

Type: object · Level: shared

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: shared

Validation: const=true

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

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

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

Type: boolean · Level: shared

Validation: schema type only

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

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

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

Type: array · Level: shared

Validation: maxItems=8

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

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

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

Type: object · Level: shared

Validation: additionalProperties=false

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

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

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

Type: array · Level: shared

Validation: minItems=1; maxItems=12

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

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

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

Type: oneOf · Level: shared

Validation: oneOf=3

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

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

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: object · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: array · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: object · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: string · Level: shared

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.
Default: inherited
Technical details

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

Type: array · Level: shared

Validation: maxItems=16; uniqueItems=true

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

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

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

Type: string · Level: shared

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

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

/layout/scrollbarNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: additionalProperties=false

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

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

Type: string · Level: shared

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

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

/navigationNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: minProperties=1; additionalProperties=false

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

/navigation/$resetNo description yet.
Technical details

Type: bool · Level: shared

Validation: const=true

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

/navigation/hiddenNo description yet.
Default: inherited; otherwise false
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/navigation/orderNo description yet.
Default: inherited
Technical details

Type: integer · Level: shared

Validation: minimum=0; maximum=2147483647

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

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

Type: string · Level: shared

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

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

/readingNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: minProperties=1; additionalProperties=false

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

/reading/$resetNo description yet.
Technical details

Type: bool · Level: shared

Validation: const=true

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

/reading/breadcrumbsNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

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

Type: string · Level: shared

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

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

/reading/previous_nextNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/reading/tocNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/reading/toc_depthNo description yet.
Default: inherited; otherwise 3
Technical details

Type: integer · Level: shared

Validation: minimum=2; maximum=6

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

/searchNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: minProperties=1; additionalProperties=false

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

/search/$resetNo description yet.
Technical details

Type: bool · Level: shared

Validation: const=true

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

/search/enabledNo description yet.
Default: inherited; otherwise false
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/search/indexedNo description yet.
Default: inherited; otherwise true
Technical details

Type: boolean · Level: shared

Validation: schema type only

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

/settingsNo description yet.
Default: inherited
Technical details

Type: object · Level: shared

Validation: minProperties=1; additionalProperties=false

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

/settings/$resetNo description yet.
Technical details

Type: bool · Level: shared

Validation: const=true

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

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

Type: string · Level: shared

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

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

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

Type: string · Level: shared

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

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

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

Type: string · Level: shared

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

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

Markdown metadata

The metadata block (front matter) at the start of a Markdown page accepts only the keys title, description, tags, draft, noindex, translation_key, profile and composition_recipe. What each key does is described in Markdown.