To preview and bundle the default UI, you need the following software on your computer:

• git (command: git)

• Node.js (commands: node and npm)

npm run bundle runs build.mjs: Vite builds the css (one pass) and each js entry (one pass per file, as self-contained classic scripts), the static directories are copied in, and everything is zipped into build/ui-bundle.zip.

The js entries are js/site.js (the numbered scripts under src/js, concatenated in order) and one js/vendor/<name>.js per src/js/vendor/<name>.bundle.js with its imports bundled in.

• mermaid: ships its own prebuilt es-module dist and breaks at runtime when re-bundled; the build copies the entry and its transitive chunk imports verbatim and loads it on demand (see partials/mermaid-script.hbs).

• pagefind: lives entirely outside this UI bundle. It is a devDependency of the repository root, indexes the finished site after the Antora build (make build-search-index) and self-serves its assets under /pagefind/. The asset hashing below does not cover it.

• @asciidoctor/tabs: doubles as a build-time Asciidoctor extension (playbook) and a runtime asset. The browser js and the css are imported by explicit path (dist/js/tabs.js, dist/css/tabs.css) because Vite honors neither the browser nor the style package field.

• highlight.js: bundled from its modular source with a curated language list in src/js/vendor/highlight.bundle.js.

• @fortawesome/fontawesome-free: the icon sprite partial partials/icons.hbs (inlined into every page by the layouts) is generated at build time from the package’s svgs (CC BY 4.0, attributed in NOTICE and in the sprite itself).

• @fontsource/*: the font files are pulled out of the packages via the ~@fontsource/ url alias in src/css/fonts.css.

The css and js entry files carry a content hash in their names and are served with immutable cache headers (see netlify.toml). The hbs templates reference them by their unhashed names; the build rewrites the references while staging the bundle. Fonts and images keep stable names with moderate cache lifetimes.

The build is wired into the Playbooks of this repository:

To see UI changes rendered with real content, build the site: make build-truly-local (or push and use the deploy preview).

We have added our own tracking solution into src/partials/head-scripts.hbs. It has the URL hardcoded. it can be enabled by setting site.keys.enable_tracking to true/false in the Antora playbook.

[Ticket](github.com/stackabletech/documentation/issues/232) - Due to the removal of HTML-passthru in v11 (which we need for [Callouts](docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/)) the highlight.js has not been updated from v10. This also affects the Antora Default UI. Both decisions will be revisited when the upstream upgrade is available.

We use pagefind for search. The index is generated as part of the build in the documentation repository. Various pagefind-* tags are used to mark content that should be indexed. Only the stable docs are indexed (no previous versions, no nightly).

This directory is a fork of the MPL-2.0-licensed Antora Default UI, and upstream commits are periodically ported into it (see UPSTREAM). Ported commits keep their original upstream authorship in the git history.

The upstream authors have not signed the Stackable CLA and are not expected to. Their code is included solely under the terms of the MPL-2.0 (see LICENSE), not under the CLA. This is intentional and applies only to the contents of this directory. As a practical consequence, the CLA check fails on pull requests that port upstream commits; such PRs are merged with an administrative override after review.

To list the authors of ported code: