Docouture
prerelease Prerelease 1.1.2 Latest 1.1.1 1.1.0 1.0.0
↑↓ navigate · ↵ select · esc close
Docouture
Docouture
prerelease Prerelease 1.1.2 Latest 1.1.1 1.1.0 1.0.0

Antora Playbook

antora-playbook.yml is Antora’s single entry-point config file — this site’s own copy is the ground truth; what follows is what each key it sets actually does. Upstream reference: Antora’s playbook docs.

site

site:
  title: docouture
  start_page: ROOT::index.adoc
  keys:
    product_logo: /_/product-logo.png
    product_logo_dark: /_/product-logo-dark.png
    favicon: /_/favicon.ico
Key Effect

title

The site’s own name, used in the UI bundle’s chrome and generated <title> tags.

start_page

A resource ID (<component>::index.adoc) generating the redirect at the site root.

keys.product_logo / product_logo_dark

Side-menu brand logo, light/dark variants — see Setup the product logo.

keys.favicon

Browser tab icon — see Setup a favicon.

keys.*

A flat map of arbitrary values the UI bundle reads (see UI Bundle) — it cannot hold a nested list, which is why nav_modules/footer/llms live in antora.yml instead (Antora Descriptor).

content

content:
  sources:
    - url: ..
      start_path: docs/src
      branches: [main]
      tags: ['docs/stable']
Key Effect

sources[].url

Git repository to aggregate content from — .. here, since the playbook sits one level below the repository root docouture new scaffolded into.

sources[].start_path

Repo-root-relative path to the component’s content root (where antora.yml lives).

sources[].branches

Which branch is aggregated as the live prerelease version — main for a trunk-based site, or an independently-named integration branch (e.g. develop) for a git-flow one — see Branching model for what sets this, and Versioning modes for what standalone vs. versioned mode sets for tags below.

sources[].tags

Which tags are aggregated as versions — same reference as branches.

ui

ui:
  bundle:
    url: ./node_modules/@inditextech/docouture-ui-bundle/build/ui-bundle.zip
    snapshot: false
  supplemental_files: ./supplemental-ui
Key Effect

bundle.url

Path to the UI bundle zip — installed as a real npm dependency and read straight out of node_modules, no build-time fetch from a URL.

bundle.snapshot

Whether Antora caches the unzipped bundle across builds (false re-reads it every time — safer while iterating on the bundle itself).

supplemental_files

Overlay directory applied onto the bundle at build time — the logo/favicon mechanism (docs/supplemental-ui/*).

output

Key Effect

dir

Where the built site lands (build/site) — where docouture publish looks by default.

urls

Key Effect

html_extension_style

indexify — every page publishes as …​/page/index.html rather than …​/page.html.

latest_version_segment

Deliberately not set — see Versioning modes and Integrations for why the /latest/ alias is implemented differently here instead.

runtime

Key Effect

log.failure_level

warn — a broken xref, a missing include target, or an unresolved attribute reference fails the build rather than shipping a gap.

log.level

info — without it, every docouture extension’s own diagnostic logging (search-index counts, version-report, Kroki's lifecycle) is silently dropped, since Antora’s own default is warn.

asciidoc

asciidoc:
  attributes:
    experimental: ''
    icons: font
    sectanchors: ''
    idprefix: ''
    idseparator: '-'
    source-highlighter: shiki
    page-pagination: '@'
    kroki-enabled: true
    kroki-diagram-types: mermaid,plantuml,bpmn,excalidraw
  extensions:
    - '@inditextech/docouture-asciidoc-extensions'
Key Effect

attributes.experimental

Turns on Asciidoctor’s experimental syntax (]+btn:[, menu:[]).

attributes.icons

font — icon macros render from an icon font/sprite rather than image files.

attributes.sectanchors

Clickable anchor links next to headings.

attributes.idprefix / idseparator

Empty prefix and a - separator mean a heading == Getting Started gets the ID getting-started, not Asciidoctor's own default _getting_started.

attributes.source-highlighter

shiki — build-time syntax highlighting, covered in Integrations.

attributes.page-pagination

@ turns on previous/next footer links for every page by default (@ makes it a soft default — a page can still opt out with :!page-pagination:).

attributes.kroki-enabled / kroki-diagram-types

Turns on diagram rendering and which languages are recognized — covered in Integrations.

extensions

Asciidoctor-level extensions (@inditextech/docouture-asciidoc-extensions — the custom blocks). A different key from antora.extensions below — see Architecture.

antora

antora:
  extensions:
    - require: '@inditextech/docouture-antora-extensions'
      duplicate_latest_version: true
Key Effect

extensions[].require

Registers @inditextech/docouture-antora-extensions — the module switcher, footer, search index and llms.txt generation together; they can’t be enabled individually.

extensions[].duplicate_latest_version

Republishes whichever version Antora computes as latest a second time under /latest/… — covered in Integrations.