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
| Field | What it does |
|---|---|
/locale | No description yet.Technical detailsType: Validation: Schema: |
/preset | No description yet.Technical detailsType: Validation: Schema: |
/schemarequired | No description yet.Technical detailsType: Validation: Schema: |
/title | No description yet.Technical detailsType: Validation: Schema: |
/version | No description yet.Technical detailsType: Validation: Schema: |
Appearance
| Field | What it does |
|---|---|
/branding | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/$reset | No description yet.Technical detailsType: Validation: Schema: |
/branding/credit | Show 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 trueTechnical detailsType: Validation: Schema: |
/branding/favicon | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/label | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/logo | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/logo_dark | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/mode | No description yet. Default: inherited; otherwise "full"Technical detailsType: Validation: Schema: |
/branding/share_image | The 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 detailsType: Validation: Schema: |
/branding/size | No description yet. Default: inherited; otherwise "medium"Technical detailsType: Validation: Schema: |
/branding/title | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/$reset | No description yet.Technical detailsType: Validation: Schema: |
/layout/container | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/container/maxrequired | No description yet. Default: inherited; otherwise 7Technical detailsType: Validation: Schema: |
/layout/content | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/content/gaprequired | No description yet. Default: inherited; otherwise nullTechnical detailsType: Validation: Schema: |
/layout/key | No description yet. Default: inherited; otherwise "docara.docs"Technical detailsType: Validation: Schema: |
/layout/regions | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/regions/$reset | No description yet.Technical detailsType: Validation: Schema: |
/layout/regions/<region> | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/$reset | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/enabled | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/bind | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/elementrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/aria_label | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/href | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/tagrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/textrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/utilities | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/utilities/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/history | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/packagerequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/propsrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/smartrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/view | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/sectionrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/utilities | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/utilities/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/scrollbar | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/scrollbar/presetrequired | No description yet. Default: inherited; otherwise "overlay"Technical detailsType: Validation: Schema: |
/settings | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/settings/$reset | No description yet.Technical detailsType: Validation: Schema: |
/settings/modal_blur | No description yet. Default: inherited; otherwise "none"Technical detailsType: Validation: Schema: |
/settings/theme | No description yet. Default: inherited; otherwise "system"Technical detailsType: Validation: Schema: |
/settings/ui_radius | No description yet. Default: inherited; otherwise "default"Technical detailsType: Validation: Schema: |
Menu, reading and search
| Field | What it does |
|---|---|
/header_navigation | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/$reset | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/enabled | No description yet. Default: inherited; otherwise falseTechnical detailsType: Validation: Schema: |
/header_navigation/enabledrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/* | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/hrefrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/idrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/labelrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/sections | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/sections/* | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/repository | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/navigation | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/navigation/$reset | No description yet.Technical detailsType: Validation: Schema: |
/navigation/hidden | No description yet. Default: inherited; otherwise falseTechnical detailsType: Validation: Schema: |
/navigation/order | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/navigation/scope | No description yet. Default: inherited; otherwise "site"Technical detailsType: Validation: Schema: |
/reading | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/reading/$reset | No description yet.Technical detailsType: Validation: Schema: |
/reading/breadcrumbs | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/reading/mobile_toc | No description yet. Default: inherited; otherwise "auto"Technical detailsType: Validation: Schema: |
/reading/previous_next | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/reading/toc | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/reading/toc_depth | No description yet. Default: inherited; otherwise 3Technical detailsType: Validation: Schema: |
/search | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/search/$reset | No description yet.Technical detailsType: Validation: Schema: |
/search/enabled | No description yet. Default: inherited; otherwise falseTechnical detailsType: Validation: Schema: |
/search/indexed | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
Examples and code
| Field | What it does |
|---|---|
/code | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/code/$reset | No description yet.Technical detailsType: Validation: Schema: |
/code/wrap | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/examples | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/examples/$reset | No description yet.Technical detailsType: Validation: Schema: |
/examples/fullscreen | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/examples/wrap | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
page.json
Basics
| Field | What it does |
|---|---|
/description | No description yet.Technical detailsType: Validation: Schema: |
/locale | No description yet.Technical detailsType: Validation: Schema: |
/preset | No description yet.Technical detailsType: Validation: Schema: |
/schemarequired | No description yet.Technical detailsType: Validation: Schema: |
/slug | No description yet.Technical detailsType: Validation: Schema: |
/title | No description yet.Technical detailsType: Validation: Schema: |
/version | No description yet.Technical detailsType: Validation: Schema: |
Appearance
| Field | What it does |
|---|---|
/branding | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/$reset | No description yet.Technical detailsType: Validation: Schema: |
/branding/credit | Show 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 trueTechnical detailsType: Validation: Schema: |
/branding/favicon | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/label | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/logo | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/logo_dark | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/mode | No description yet. Default: inherited; otherwise "full"Technical detailsType: Validation: Schema: |
/branding/share_image | The 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 detailsType: Validation: Schema: |
/branding/size | No description yet. Default: inherited; otherwise "medium"Technical detailsType: Validation: Schema: |
/branding/title | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/$reset | No description yet.Technical detailsType: Validation: Schema: |
/layout/container | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/container/maxrequired | No description yet. Default: inherited; otherwise 7Technical detailsType: Validation: Schema: |
/layout/content | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/content/gaprequired | No description yet. Default: inherited; otherwise nullTechnical detailsType: Validation: Schema: |
/layout/key | No description yet. Default: inherited; otherwise "docara.docs"Technical detailsType: Validation: Schema: |
/layout/regions | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/regions/$reset | No description yet.Technical detailsType: Validation: Schema: |
/layout/regions/<region> | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/$reset | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/enabled | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/bind | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/elementrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/aria_label | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/href | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/tagrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/textrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/utilities | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/utilities/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/history | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/packagerequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/propsrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/smartrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/view | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/sectionrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/utilities | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/utilities/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/scrollbar | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/scrollbar/presetrequired | No description yet. Default: inherited; otherwise "overlay"Technical detailsType: Validation: Schema: |
/settings | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/settings/$reset | No description yet.Technical detailsType: Validation: Schema: |
/settings/modal_blur | No description yet. Default: inherited; otherwise "none"Technical detailsType: Validation: Schema: |
/settings/theme | No description yet. Default: inherited; otherwise "system"Technical detailsType: Validation: Schema: |
/settings/ui_radius | No description yet. Default: inherited; otherwise "default"Technical detailsType: Validation: Schema: |
Menu, reading and search
| Field | What it does |
|---|---|
/header_navigation | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/$reset | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/enabled | No description yet. Default: inherited; otherwise falseTechnical detailsType: Validation: Schema: |
/header_navigation/enabledrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/* | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/hrefrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/idrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/labelrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/sections | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/sections/* | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/repository | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/navigation | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/navigation/$reset | No description yet.Technical detailsType: Validation: Schema: |
/navigation/hidden | No description yet. Default: inherited; otherwise falseTechnical detailsType: Validation: Schema: |
/navigation/order | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/navigation/scope | No description yet. Default: inherited; otherwise "site"Technical detailsType: Validation: Schema: |
/reading | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/reading/$reset | No description yet.Technical detailsType: Validation: Schema: |
/reading/breadcrumbs | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/reading/mobile_toc | No description yet. Default: inherited; otherwise "auto"Technical detailsType: Validation: Schema: |
/reading/previous_next | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/reading/toc | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/reading/toc_depth | No description yet. Default: inherited; otherwise 3Technical detailsType: Validation: Schema: |
/search | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/search/$reset | No description yet.Technical detailsType: Validation: Schema: |
/search/enabled | No description yet. Default: inherited; otherwise falseTechnical detailsType: Validation: Schema: |
/search/indexed | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
Examples and code
| Field | What it does |
|---|---|
/code | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/code/$reset | No description yet.Technical detailsType: Validation: Schema: |
/code/wrap | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/examples | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/examples/$reset | No description yet.Technical detailsType: Validation: Schema: |
/examples/fullscreen | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/examples/wrap | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
Shared presentation fields
These branches are the same on all three levels. The table is built from
presentation.schema.json.
| Field | What it does |
|---|---|
/branding | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/$reset | No description yet.Technical detailsType: Validation: Schema: |
/branding/credit | Show 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 trueTechnical detailsType: Validation: Schema: |
/branding/favicon | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/label | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/logo | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/logo_dark | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/branding/mode | No description yet. Default: inherited; otherwise "full"Technical detailsType: Validation: Schema: |
/branding/share_image | The 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 detailsType: Validation: Schema: |
/branding/size | No description yet. Default: inherited; otherwise "medium"Technical detailsType: Validation: Schema: |
/branding/title | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/code | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/code/$reset | No description yet.Technical detailsType: Validation: Schema: |
/code/wrap | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/examples | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/examples/$reset | No description yet.Technical detailsType: Validation: Schema: |
/examples/fullscreen | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/examples/wrap | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/header_navigation | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/$reset | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/enabled | No description yet. Default: inherited; otherwise falseTechnical detailsType: Validation: Schema: |
/header_navigation/enabledrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/* | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/hrefrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/idrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/labelrequired | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/sections | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/items/*/sections/* | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/header_navigation/repository | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/$reset | No description yet.Technical detailsType: Validation: Schema: |
/layout/container | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/container/maxrequired | No description yet. Default: inherited; otherwise 7Technical detailsType: Validation: Schema: |
/layout/content | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/content/gaprequired | No description yet. Default: inherited; otherwise nullTechnical detailsType: Validation: Schema: |
/layout/key | No description yet. Default: inherited; otherwise "docara.docs"Technical detailsType: Validation: Schema: |
/layout/regions | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/regions/$reset | No description yet.Technical detailsType: Validation: Schema: |
/layout/regions/<region> | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/$reset | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/enabled | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/bind | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/elementrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/aria_label | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/href | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/tagrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/textrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/utilities | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/utilities/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/history | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/packagerequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/propsrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/smartrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/view | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/idrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/sectionrequired | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/utilities | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/utilities/* | No description yet. Default: inherited Technical detailsPath: Type: Validation: Schema: |
/layout/scrollbar | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/layout/scrollbar/presetrequired | No description yet. Default: inherited; otherwise "overlay"Technical detailsType: Validation: Schema: |
/navigation | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/navigation/$reset | No description yet.Technical detailsType: Validation: Schema: |
/navigation/hidden | No description yet. Default: inherited; otherwise falseTechnical detailsType: Validation: Schema: |
/navigation/order | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/navigation/scope | No description yet. Default: inherited; otherwise "site"Technical detailsType: Validation: Schema: |
/reading | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/reading/$reset | No description yet.Technical detailsType: Validation: Schema: |
/reading/breadcrumbs | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/reading/mobile_toc | No description yet. Default: inherited; otherwise "auto"Technical detailsType: Validation: Schema: |
/reading/previous_next | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/reading/toc | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/reading/toc_depth | No description yet. Default: inherited; otherwise 3Technical detailsType: Validation: Schema: |
/search | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/search/$reset | No description yet.Technical detailsType: Validation: Schema: |
/search/enabled | No description yet. Default: inherited; otherwise falseTechnical detailsType: Validation: Schema: |
/search/indexed | No description yet. Default: inherited; otherwise trueTechnical detailsType: Validation: Schema: |
/settings | No description yet. Default: inherited Technical detailsType: Validation: Schema: |
/settings/$reset | No description yet.Technical detailsType: Validation: Schema: |
/settings/modal_blur | No description yet. Default: inherited; otherwise "none"Technical detailsType: Validation: Schema: |
/settings/theme | No description yet. Default: inherited; otherwise "system"Technical detailsType: Validation: Schema: |
/settings/ui_radius | No description yet. Default: inherited; otherwise "default"Technical detailsType: Validation: Schema: |
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.