You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Split chrome to valentus-theme and release as antora-dark-mode v1.2.0.
Doc-site layout chrome moves to valentus-theme; this repo is dark mode only. Prepares GitHub rename from antora-dark-theme to antora-dark-mode.
Co-authored-by: Cursor <cursoragent@cursor.com>
Copy file name to clipboardExpand all lines: CHANGELOG.adoc
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,8 +10,14 @@ Entries below are in **chronological order** by date: prior release, then the **
10
10
11
11
== [Unreleased]
12
12
13
+
== [1.2.0] - 2026-06-09
14
+
15
+
* *Split:* Repository renamed to `antora-dark-mode`; doc chrome (mast, header, layout, VCS icons) moved to link:https://github.com/antora-supplemental/valentus-theme[valentus-theme]. This package is dark mode only (`site-extra.css`, FOUC script, theme toggle).
16
+
* *Breaking:* `ui-modules/` removed; consumers that need composable chrome should use valentus-theme manifests. Replace `antora-dark-theme` release bundle URLs with `antora-dark-mode`.
13
17
* *Distribution:* Release workflow runs only on semver tags (`vX.Y.Z`); rolling alias pushes no longer re-trigger full releases. Post-release resolves the tagged commit explicitly, bootstraps sibling minor lines within the same major only, and updates rolling aliases via `gh release create --target` (no `git push` of moving tags).
* *Distribution:* Release workflow publishes rolling prerelease aliases (`v1`, `v1.0`, `v1.1`, …) that track the latest patch within each semver line; `supported-lines.json` records current pointers.
* `site-extra.css`: doc home **project tiles** (AsciiDoc `+.openblock.cards+` and `+.exampleblock.tile+`) — grid layout, light/dark design tokens, hover elevation, `prefers-reduced-motion`, and print. Implemented in the supplemental layer so the merged `ui-bundle.zip` and npm `prebuild` sync (e.g. FoodTruckNerdz/docs) pick up the styles; stock Antora `doc.css` alone does not include them.
86
-
* *Release and consume:* bump `version` in `package.json` to match the intended tag, commit, then push a Git `v*` tag (e.g. `v1.0.3`). The link:.github/workflows/release.yml[Release workflow] creates the GitHub Release, attaches the npm tarball and `ui-bundle.zip`, and (for non-prerelease tags) can publish to the npm registry — maintainers do not run `pnpm publish` or `npm publish` locally. Downstream, update the `antora-dark-theme` devDependency and run `pnpm run prebuild` (e.g. in https://github.com/FoodTruckNerdz/docs[FoodTruckNerdz/docs]) so the sync script copies `node_modules/.../supplemental-ui` into `site/supplemental-ui/`.
87
-
* *Local test of an unpublished tree:* from the theme repo, `pnpm pack`, then in the consumer repo `pnpm add -D ./antora-dark-theme-1.0.3.tgz`, or `pnpm add -D "file:../../path/to/antora-dark-theme"`, then `pnpm run prebuild`.
92
+
* *Release and consume:* bump `version` in `package.json` to match the intended tag, commit, then push a Git `v*` tag (e.g. `v1.0.3`). The link:.github/workflows/release.yml[Release workflow] creates the GitHub Release, attaches the npm tarball and `ui-bundle.zip`, and (for non-prerelease tags) can publish to the npm registry — maintainers do not run `pnpm publish` or `npm publish` locally. Downstream, update the `antora-dark-mode` devDependency and run `pnpm run prebuild` (e.g. in https://github.com/FoodTruckNerdz/docs[FoodTruckNerdz/docs]) so the sync script copies `node_modules/.../supplemental-ui` into `site/supplemental-ui/`.
93
+
* *Local test of an unpublished tree:* from the theme repo, `pnpm pack`, then in the consumer repo `pnpm add -D ./antora-dark-mode-1.0.3.tgz`, or `pnpm add -D "file:../../path/to/antora-dark-mode"`, then `pnpm run prebuild`.
**Changelog:** link:CHANGELOG.adoc[CHANGELOG.adoc] (summaries) and link:changelog-details/[`changelog-details/`] (dated detail files).
22
22
@@ -30,9 +30,6 @@ toc::[]
30
30
* **No FOUC (Flash of Unstyled Content)** - Dark mode is applied before page render via inline script
31
31
* **Non-invasive** - Works as a supplemental UI overlay; no need to fork or rebuild the Antora default UI bundle
32
32
* **Comprehensive styling** - Covers navbar, navigation panels, content area, code blocks, tables, admonition blocks, footer, and more
33
-
* **VCS repo logo** - Replaces the default UI's nonfunctional "Download" button with a version-control provider logo (GitHub, GitLab, Bitbucket, Gitea, Codeberg, Forgejo, SourceHut) that links to the docs repository; provider is detected by domain
34
-
* **Debranded “doc site” layout** - Full supplemental partials and `site-doc-layout.css` (load after `site-extra.css` in `head-meta`): sticky site chrome, doc mast (component/version pickers in the breadcrumb row), sidebar with component label + page tree, optional edit-in-repo link, Source Sans~3, and `adt-*` BEM-style hooks (not tied to a product name). A neutral `img/logo.svg` is used in the top bar; set playbook `site.keys.header_logo` (basename under `img/`) and drop your SVG in supplemental—no header partial fork required.
35
-
* **Playbook `site.keys` (optional site identity):** `header_logo` (header image basename under `img/`; default: `logo.svg`), `site_home_url` (default: docs home `site.url`), `site_home_label` (a11y label for the logo link), `header_doc_title` (navbar text beside the logo; default: `site.title`), `github_profile_url` (fallback when the page has no `origin` URL), `footer_note` (HTML fragment after the base footer line), `title_bar_brand` / `title_bar_section` (see `partials/head-title.hbs`).
36
33
* **Version pinning strategies** — exact semver pin (recommended for production), `releases/latest`, rolling line aliases (`v1.0`, `v1.1`, `v1`), `supported-lines.json`, and Renovate regex example; see the xref:version-pinning.adoc[Version Pinning guide] in the docs module.
37
34
38
35
== Help Get Dark Mode into Antora
@@ -44,6 +41,8 @@ If you'd like to see native dark mode support in Antora, please upvote the featu
44
41
45
42
Your support helps the Antora team prioritize this feature!
46
43
44
+
**Doc-site chrome** (mast, header layout, VCS icons) lives in the separate link:https://github.com/antora-supplemental/valentus-theme[valentus-theme] project. Pair valentus supplemental UI on top of this dark-mode release bundle when you want both.
45
+
47
46
== Quick Start
48
47
49
48
Use the release bundle. That is the correct default—not a mild preference.
@@ -57,7 +56,7 @@ You do not need this project on npm.
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# DEPRECATED — do not install
2
2
3
-
**This npm package is retired.** It will not receive updates. New documentation sites must not add `antora-dark-theme` as a dependency.
3
+
**This npm package is retired.** It will not receive updates. New documentation sites must not add `antora-dark-mode` as a dependency.
4
4
5
5
If the yellow deprecation banner above this README is hard to read (npm dark theme), **use this README instead** — it is the authoritative migration notice.
Pin an exact semver tag for production. See [Version Pinning](https://antora-supplemental.github.io/antora-dark-theme/antora-dark-theme/guide/version-pinning.html) for `releases/latest`, rolling line tags (`v1.0`, `v1`), and Renovate.
34
+
Pin an exact semver tag for production. See [Version Pinning](https://antora-supplemental.github.io/antora-dark-mode/antora-dark-mode/guide/version-pinning.html) for `releases/latest`, rolling line tags (`v1.0`, `v1`), and Renovate.
35
35
36
36
### 2. Optional branding (one directory only)
37
37
@@ -42,26 +42,26 @@ Pin an exact semver tag for production. See [Version Pinning](https://antora-sup
42
42
### 3. Remove this package if it is already installed
43
43
44
44
```bash
45
-
pnpm remove -D antora-dark-theme
46
-
# or: npm uninstall antora-dark-theme
45
+
pnpm remove -D antora-dark-mode
46
+
# or: npm uninstall antora-dark-mode
47
47
```
48
48
49
-
Delete any `prebuild` / `sync:ui` scripts that copied `node_modules/antora-dark-theme/supplemental-ui`.
49
+
Delete any `prebuild` / `sync:ui` scripts that copied `node_modules/antora-dark-mode/supplemental-ui`.
* https://github.com/antora-supplemental/antora-dark-theme/blob/main/docs/modules/guide/pages/vcs-repo-logo.adoc[VCS repo logo guide]: icon sourcing, layout, troubleshooting when the logo does not show locally
16
+
* https://github.com/antora-supplemental/antora-dark-mode/blob/main/docs/modules/guide/pages/vcs-repo-logo.adoc[VCS repo logo guide]: icon sourcing, layout, troubleshooting when the logo does not show locally
Copy file name to clipboardExpand all lines: changelog-details/2026-04-26 - 1.0.3 doc home tiles in supplemental.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,8 @@
3
3
The Antora hub home page uses an open block with class `cards` and example blocks with class `tile`.
4
4
Styling for `+.openblock.cards+` and `+.exampleblock.tile+` is delivered from `supplemental-ui/css/site-extra.css` so that:
5
5
6
-
* The https://github.com/antora-supplemental/antora-dark-theme/releases[GitHub release] `ui-bundle.zip` (default UI from GitLab + merged supplemental) includes the rules.
7
-
* Playbooks that install the `antora-dark-theme` npm package and run a sync script (for example `prebuild` in https://github.com/FoodTruckNerdz/docs[FoodTruckNerdz/docs]) copy an up-to-date `site-extra.css` into `site/supplemental-ui/`.
6
+
* The https://github.com/antora-supplemental/antora-dark-mode/releases[GitHub release] `ui-bundle.zip` (default UI from GitLab + merged supplemental) includes the rules.
7
+
* Playbooks that install the `antora-dark-mode` npm package and run a sync script (for example `prebuild` in https://github.com/FoodTruckNerdz/docs[FoodTruckNerdz/docs]) copy an up-to-date `site-extra.css` into `site/supplemental-ui/`.
8
8
9
9
Light-mode tokens use `:root` with `var(--panel-border-color)` and `var(--color-white)` from the default UI; `html.dark-theme` overrides the tile custom properties.
10
10
The `exampleblock.tile``> .content` rules use `!important` for background and border in dark mode so they override the generic `html.dark-theme .doc .exampleblock > .content` supplemental rules.
0 commit comments