docara.json
docara.json is the settings file of the whole site. Only here do you set
the content root, the base and public address, the language registry and the
address rules, the documentation version, the redirects file, the reader
panel, the Framework lock and the namespace of the project’s Smart
components. The presentation, menu and reading fields set here serve as
defaults for all pages.
How to read the field tables
The tables below are built at build time from the JSON Schema and the Docara
code, so they include every docara.json field. The “Default” line under a
description shows the value Docara uses when the field is not set. If there
is no such line, there is no default: the field is required, or the feature
is off without it. “Technical details” give the type, the validation rule and
the place in the schema.
You can also set the presentation, menu and reading fields in section.json
and <page>.page.json: see section.json and page.json.
How levels and inheritance work is described in
Site, section and page.
Basics
| Field | What it does |
|---|---|
/content_root | No description yet. Default: "content"Technical detailsType: Validation: Schema: |
/documentation_version | No description yet. Default: "current"Technical detailsType: Validation: Schema: |
/framework_lockrequired | No description yet.Technical detailsType: Validation: Schema: |
/presetrequired | No description yet.Technical detailsType: Validation: Schema: |
/schemarequired | No description yet.Technical detailsType: Validation: Schema: |
/title | No description yet. Default: "Docara"Technical detailsType: Validation: Schema: |
/version | No description yet.Technical detailsType: Validation: Schema: |
Address and publication
More in Site address and search engines.
| Field | What it does |
|---|---|
/base_url | No description yet. Default: "/"Technical detailsType: Validation: Schema: |
/discovery | What llms.txt says about the site. Used only when site_url is set.Technical detailsType: Validation: Schema: |
/discovery/description | No description yet.Technical detailsType: Validation: Schema: |
/discovery/llms_links | No description yet. Default: []Technical detailsType: Validation: Schema: |
/discovery/llms_links/* | No description yet.Technical detailsType: Validation: Schema: |
/discovery/llms_links/*/description | No description yet.Technical detailsType: Validation: Schema: |
/discovery/llms_links/*/pathrequired | No description yet.Technical detailsType: Validation: Schema: |
/discovery/llms_links/*/titlerequired | No description yet.Technical detailsType: Validation: Schema: |
/not_found | The 404.html page at the deployment base, in the default locale, with the site's header, navigation, search and theme. Built unless enabled is false. The content is the error.not_found.* strings of the default locale's lang.json (Docara has English and Russian ones), or the site's 404.md at the root of the default locale's content. The page is noindex and stays out of the navigation, search, sitemap.xml and llms.txt. A portal build has none: the portal owns 404.html, and enabled true there is an error.Technical detailsType: Validation: Schema: |
/not_found/enabledrequired | No description yet. Default: trueTechnical detailsType: Validation: Schema: |
/page_transforms | Commands run over the written site before Docara measures it: each gets the site's directory as its last argument and runs in the project root; a failure fails the build. Default: []Technical detailsType: Validation: Schema: |
/page_transforms/* | No description yet.Technical detailsType: Validation: Schema: |
/page_transforms/*/commandrequired | No description yet.Technical detailsType: Validation: Schema: |
/page_transforms/*/command/* | No description yet.Technical detailsType: Validation: Schema: |
/portal | Builds the site for one path of a portal, such as /ru/docara/docs/ on https://simai.io/. Needs site_url, one locale and locale_routing.strategy default_unprefixed. The build writes llms.txt but no sitemap.xml or robots.txt, refuses CNAME, .nojekyll, robots.txt, sitemap.xml and 404.html, and links back to home_url from the header. docara portal-artifact packs it.Technical detailsType: Validation: Schema: |
/portal/home_label | No description yet.Technical detailsType: Validation: Schema: |
/portal/home_urlrequired | No description yet.Technical detailsType: Validation: Schema: |
/portal/productrequired | No description yet.Technical detailsType: Validation: Schema: |
/redirects_file | No description yet.Technical detailsType: Validation: Schema: |
/site_url | The site's absolute public address: origin plus base_url, such as https://example.com/docs/. When set, the build writes sitemap.xml, robots.txt and llms.txt.Technical detailsType: Validation: Schema: |
Languages and translations
More in Multilingual site.
| Field | What it does |
|---|---|
/default_locale | No description yet.Technical detailsType: Validation: Schema: |
/locale | No description yet.Technical detailsType: Validation: Schema: |
/locale_routing | No description yet. Default: {"strategy":"default_unprefixed","root":"default_locale","detect_browser_language":false,"legacy_unprefixed_redirects":false}Technical detailsType: Validation: Schema: |
/locale_routing/detect_browser_languagerequired | No description yet.Technical detailsType: Validation: Schema: |
/locale_routing/legacy_unprefixed_redirects | No description yet.Technical detailsType: Validation: Schema: |
/locale_routing/rootrequired | No description yet.Technical detailsType: Validation: Schema: |
/locale_routing/strategyrequired | No description yet.Technical detailsType: Validation: Schema: |
/locales | No description yet.Technical detailsType: Validation: Schema: |
/locales/<locale> | No description yet.Technical detailsPath: Type: Validation: Schema: |
/locales/<locale>/content_rootrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/locales/<locale>/directionrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/locales/<locale>/fallbacks | No description yet. Default: []Technical detailsPath: Type: Validation: Schema: |
/locales/<locale>/fallbacks/* | No description yet.Technical detailsPath: Type: Validation: Schema: |
/locales/<locale>/labelrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/locales/<locale>/public_prefix | No description yet.Technical detailsPath: Type: Validation: Schema: |
/locales/missing_page_policy | No description yet. Default: "skip"Technical detailsType: Validation: Schema: |
/translation_tracking | No description yet.Technical detailsType: Validation: Schema: |
/translation_tracking/enabledrequired | No description yet.Technical detailsType: Validation: Schema: |
/translation_tracking/lock_filerequired | No description yet.Technical detailsType: Validation: Schema: |
/translation_tracking/moderequired | No description yet.Technical detailsType: Validation: Schema: |
/translation_tracking/source_localerequired | No description yet.Technical detailsType: Validation: Schema: |
Appearance
More in Brand and theme and Layout regions.
| Field | What it does |
|---|---|
/branding | No description yet.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: trueTechnical detailsType: Validation: Schema: |
/branding/favicon | No description yet.Technical detailsType: Validation: Schema: |
/branding/label | No description yet.Technical detailsType: Validation: Schema: |
/branding/logo | No description yet.Technical detailsType: Validation: Schema: |
/branding/logo_dark | No description yet.Technical detailsType: Validation: Schema: |
/branding/mode | No description yet. Default: "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.Technical detailsType: Validation: Schema: |
/branding/size | No description yet. Default: "medium"Technical detailsType: Validation: Schema: |
/branding/title | No description yet.Technical detailsType: Validation: Schema: |
/effects | The SIMAI Framework background effects catalogue (SF.Effects) that hero effects load from. Written to SF_BOOT_CONFIG.effects. Pin catalogue to a commit. Needs a Framework pair with SF.Effects (ui-08c07b3e938a or later).Technical detailsType: Validation: Schema: |
/effects/cataloguerequired | No description yet.Technical detailsType: Validation: Schema: |
/effects/index | No description yet.Technical detailsType: Validation: Schema: |
/effects/index_sha256 | No description yet.Technical detailsType: Validation: Schema: |
/layout | No description yet.Technical detailsType: Validation: Schema: |
/layout/$reset | No description yet.Technical detailsType: Validation: Schema: |
/layout/container | No description yet.Technical detailsType: Validation: Schema: |
/layout/container/maxrequired | No description yet. Default: 7Technical detailsType: Validation: Schema: |
/layout/content | No description yet.Technical detailsType: Validation: Schema: |
/layout/content/gaprequired | No description yet. Default: nullTechnical detailsType: Validation: Schema: |
/layout/key | No description yet. Default: "docara.docs"Technical detailsType: Validation: Schema: |
/layout/regions | No description yet.Technical detailsType: Validation: Schema: |
/layout/regions/$reset | No description yet.Technical detailsType: Validation: Schema: |
/layout/regions/<region> | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/$reset | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/enabled | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/* | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/* | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/bind | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/blockrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/elementrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/aria_label | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/href | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/tagrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/textrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/utilities | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/element/utilities/* | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/history | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/idrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/packagerequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/propsrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/slotrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/smartrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/blocks/*/view | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/idrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/sectionrequired | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/utilities | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/regions/<region>/sections/*/utilities/* | No description yet.Technical detailsPath: Type: Validation: Schema: |
/layout/scrollbar | No description yet.Technical detailsType: Validation: Schema: |
/layout/scrollbar/presetrequired | No description yet. Default: "overlay"Technical detailsType: Validation: Schema: |
/settings | No description yet.Technical detailsType: Validation: Schema: |
/settings/$reset | No description yet.Technical detailsType: Validation: Schema: |
/settings/modal_blur | No description yet. Default: "none"Technical detailsType: Validation: Schema: |
/settings/theme | No description yet. Default: "system"Technical detailsType: Validation: Schema: |
/settings/ui_radius | No description yet. Default: "default"Technical detailsType: Validation: Schema: |
/theme | The site's colours from one main colour: color is a hex colour, #rgb or #rrggbb; hue (0-360) and chroma (0-150) override how the colour is read.Technical detailsType: Validation: Schema: |
/theme/chroma | No description yet.Technical detailsType: Validation: Schema: |
/theme/colorrequired | No description yet.Technical detailsType: Validation: Schema: |
/theme/hue | No description yet.Technical detailsType: Validation: Schema: |
Menu, reading and search
More in Menu and sections, Reading context, Search and Reader panel.
| Field | What it does |
|---|---|
/header_navigation | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/$reset | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/enabled | No description yet. Default: falseTechnical detailsType: Validation: Schema: |
/header_navigation/enabledrequired | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/items | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/items/* | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/items/*/hrefrequired | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/items/*/idrequired | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/items/*/labelrequired | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/items/*/sections | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/items/*/sections/* | No description yet.Technical detailsType: Validation: Schema: |
/header_navigation/repository | No description yet.Technical detailsType: Validation: Schema: |
/navigation | No description yet.Technical detailsType: Validation: Schema: |
/navigation/$reset | No description yet.Technical detailsType: Validation: Schema: |
/navigation/hidden | No description yet. Default: falseTechnical detailsType: Validation: Schema: |
/navigation/order | No description yet.Technical detailsType: Validation: Schema: |
/navigation/scope | No description yet. Default: "site"Technical detailsType: Validation: Schema: |
/reader_preferences | No description yet. Default: {"enabled":true,"view":"menu","groups":[{"id":"appearance","fields":["appearance.theme","appearance.font_size","appearance.content_width"]}]}Technical detailsType: Validation: Schema: |
/reader_preferences/enabledrequired | No description yet.Technical detailsType: Validation: Schema: |
/reader_preferences/groupsrequired | No description yet.Technical detailsType: Validation: Schema: |
/reader_preferences/groups/* | No description yet.Technical detailsType: Validation: Schema: |
/reader_preferences/groups/*/fieldsrequired | No description yet.Technical detailsType: Validation: Schema: |
/reader_preferences/groups/*/fields/* | No description yet.Technical detailsType: Validation: Schema: |
/reader_preferences/groups/*/idrequired | No description yet.Technical detailsType: Validation: Schema: |
/reader_preferences/hidden_fields | No description yet. Default: []Technical detailsType: Validation: Schema: |
/reader_preferences/hidden_fields/* | No description yet.Technical detailsType: Validation: Schema: |
/reader_preferences/viewrequired | No description yet.Technical detailsType: Validation: Schema: |
/reading | No description yet.Technical detailsType: Validation: Schema: |
/reading/$reset | No description yet.Technical detailsType: Validation: Schema: |
/reading/breadcrumbs | No description yet. Default: trueTechnical detailsType: Validation: Schema: |
/reading/mobile_toc | No description yet. Default: "auto"Technical detailsType: Validation: Schema: |
/reading/previous_next | No description yet. Default: trueTechnical detailsType: Validation: Schema: |
/reading/toc | No description yet. Default: trueTechnical detailsType: Validation: Schema: |
/reading/toc_depth | No description yet. Default: 3Technical detailsType: Validation: Schema: |
/search | No description yet.Technical detailsType: Validation: Schema: |
/search/$reset | No description yet.Technical detailsType: Validation: Schema: |
/search/enabled | No description yet. Default: falseTechnical detailsType: Validation: Schema: |
/search/indexed | No description yet. Default: trueTechnical detailsType: Validation: Schema: |
Examples, code and extensions
| Field | What it does |
|---|---|
/code | No description yet.Technical detailsType: Validation: Schema: |
/code/$reset | No description yet.Technical detailsType: Validation: Schema: |
/code/wrap | No description yet. Default: trueTechnical detailsType: Validation: Schema: |
/documentation_tracking | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/enabledrequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/lock_filerequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/moderequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/source_localerequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/sourcesrequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/* | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/filerequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/framework_lockrequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/idrequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/idrequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/linkage | Framework linkage (standard simai.linkage): the unit inventories, change reports and change journal the site keeps, so docara documentation linkage and the build report which pages describe units that changed.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/linkage/brought_up_on | The day the pages were brought up to since; journal records without a unit version count when recorded later.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/linkage/changes | simai.framework.unit-change-report files between since and inventory.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/linkage/changes/* | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/linkage/inventoryrequired | The simai.framework.unit-inventory of the release the site builds against.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/linkage/journal | The simai.change-journal whose instructions are quoted.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/linkage/since | The inventory of the release the pages were last brought up to; required unless usage is given.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/linkage/usage | A hand-kept simai.framework.unit-usage record used instead of the one derived from the documentation lock.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/providerrequired | No description yet.Technical detailsType: Validation: Schema: |
/documentation_tracking/sources/*/providerrequired | No description yet.Technical detailsType: Validation: Schema: |
/examples | No description yet.Technical detailsType: Validation: Schema: |
/examples/$reset | No description yet.Technical detailsType: Validation: Schema: |
/examples/fullscreen | No description yet. Default: trueTechnical detailsType: Validation: Schema: |
/examples/wrap | No description yet. Default: trueTechnical detailsType: Validation: Schema: |
/smart | No description yet.Technical detailsType: Validation: Schema: |
/smart/namespacerequired | No description yet.Technical detailsType: Validation: Schema: |