Source: ViewEdit

Theme & dark-mode products

How the organization splits doc-site chrome and dark mode across repositories.

Product map

Product Role Install shape

valentus-theme

Composed doc-site chrome (mast, header, layout, VCS icons) with bundled dark mode

Release ui-bundle.zip as ui.bundle (usual full-stack install)

antora-dark-mode

Dark mode only — toggle, FOUC prevention, CSS overlay

supplemental_files or ui-module on another theme / Default UI; optional convenience zip for Default UI alone

antora-dark-theme (retired)

Former monolithic package (chrome + dark in one name)

Do not use. Migrate to Valentus (full) or antora-dark-mode (overlay)

Choose quickly

  • Need sticky header, breadcrumb mast, and dark toggle together → valentus-theme

  • Already happy with Default UI (or another theme) and only want a dark toggle → antora-dark-mode

  • Still pinning antora-dark-theme URLs or a personal fork of that name → migrate (see below)

Do not put Valentus in ui.bundle and also layer antora-dark-mode on top — Valentus already includes dark mode.

Demo content (fixtures)

Valentus body fixtures for theme and stack demos live in demo-data (demo-pages), composed via git content.sources — not copied into each theme/extension repo. Catalog: Demo data catalog. Tutorial: Build a composable Antora demo.

On Valentus and Facto stack demo sites, fixtures publish under the shared demo-pages component from demo-data (path shape https://docs.antora-supplemental.org/demo-pages/… after indexify).

Canonical docs

GitHub topic strings (gallery + dependents)

The theme gallery uses prescribed capability topics such as antora-theme, antora-dark-theme, and antora-dark-mode for appearance filters. Those topic strings describe capability (full theme vs slipstream overlay) — they are not the retired npm package name.

Separately, every site that depends on a named theme must add that theme’s product topic (exact GitHub repository name) so dependents stay rediscoverable:

  • Valentus consumers that do not use a compose pack → topic valentus-theme (gh search repos --topic valentus-theme); hubs on facto-stack tag the pack only

  • Dark-mode overlay consumers → topic antora-dark-mode when appropriate

Provider rule: a playbook repo tags the provider it declares. Hubs on @antora-supplemental/facto-stack carry facto-stack only — not the Valentus bundle, and not pack members such as page-context, site-nav-tree, soft-nav-page-toc, or linkinator. Full checklist: Hub GitHub topics.

See the extensions-registry contributing guide (Product dependency topics) and the Valentus guide on GitHub Topics.

See also