UI development

Antora uses UI bundles to define the look and feel of a documentation site. They are developed separately and are built into a ZIP file, to be consumed by Antoraโ€™s default site generator pipeline.

docs.dt.in.th, like other Antora-based sites, uses its own UI bundle. The source code is located in the dtinth/docs-ui repository, while the built ZIP file is directly checked in to the dtinth/docs repository.

Why check the UI bundle directly into the docs repo?

Most Antora projects use a URL to point to the Antora UI bundle. But checking in the UI bundle directly into the docs repo allows the UI to be bundled with the dtinth-docs command without requiring a separate release process which introduces unnecessary overhead.

Updating UI bundle

Assuming that the docs repo and docs-ui repos are next to each other:

๐Ÿ“’ docs
  ๐Ÿ“‚ .git
  ๐Ÿ“„ update-ui.sh
  ๐Ÿ“„ ui-bundle-*.zip
  ๐Ÿ“„ โ€ฆ
๐Ÿ“’ docs-ui
  ๐Ÿ“‚ .git
  ๐Ÿ“„ โ€ฆ

Within the docs repo, run:


to update the UI bundle.