Skip to content

Commit 2c92ef3

Browse files
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>
1 parent b7dad5f commit 2c92ef3

60 files changed

Lines changed: 141 additions & 1556 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/scripts/post-release.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { mkdtempSync, unlinkSync, writeFileSync } from "node:fs";
88
import { tmpdir } from "node:os";
99
import { join } from "node:path";
1010

11-
const REPO = process.env.GITHUB_REPOSITORY || "antora-supplemental/antora-dark-theme";
11+
const REPO = process.env.GITHUB_REPOSITORY || "antora-supplemental/antora-dark-mode";
1212
const BASE = `https://github.com/${REPO}/releases/download`;
1313

1414
function sh(cmd, opts = {}) {

CHANGELOG.adoc

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,14 @@ Entries below are in **chronological order** by date: prior release, then the **
1010

1111
== [Unreleased]
1212

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`.
1317
* *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).
1418

19+
link:changelog-details/2026-06-09%20-%201.2.0%20split%20valentus%20and%20rename.adoc[Detailed notes — 2026-06-09]
20+
1521
== [1.1.0] - 2026-06-08
1622

1723
* *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.
@@ -83,8 +89,8 @@ link:changelog-details/2026-04-26%20-%201.0.5%20debranded%20doc%20layout%20and%2
8389
== [1.0.3] - 2026-04-26
8490

8591
* `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`.
8894

8995
link:changelog-details/2026-04-26%20-%201.0.3%20doc%20home%20tiles%20in%20supplemental.adoc[Detailed notes — 2026-04-26]
9096

CONTRIBUTING.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ This document provides guidelines and information for contributors.
1717
+
1818
[source,bash]
1919
----
20-
git clone https://github.com/antora-supplemental/antora-dark-theme.git
21-
cd antora-dark-theme
20+
git clone https://github.com/antora-supplemental/antora-dark-mode.git
21+
cd antora-dark-mode
2222
----
2323

2424
. Install dependencies:

README.adoc

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
= Antora Dark Theme
1+
= Antora Dark Mode
22
:toc: macro
33
:toc-title: Contents
44
:toclevels: 3
55
:icons: font
66
:source-highlighter: highlight.js
77
:url-antora: https://antora.org
88
:url-antora-ui: https://gitlab.com/antora/antora-ui-default
9-
:url-demo: https://antora-supplemental.github.io/antora-dark-theme
9+
:url-demo: https://antora-supplemental.github.io/antora-dark-mode
1010

1111
A dark mode UI for {url-antora}[Antora] documentation sites.
1212

@@ -16,7 +16,7 @@ Discover this theme via link:https://antora-supplemental.github.io/docs/[Antora
1616

1717
image:https://img.shields.io/badge/license-MIT-blue.svg[License: MIT]
1818
image:https://img.shields.io/badge/antora-3.x-purple.svg[Antora 3.x]
19-
image:https://github.com/antora-supplemental/antora-dark-theme/actions/workflows/deploy.yml/badge.svg[Build Status,link=https://github.com/antora-supplemental/antora-dark-theme/actions/workflows/deploy.yml]
19+
image:https://github.com/antora-supplemental/antora-dark-mode/actions/workflows/deploy.yml/badge.svg[Build Status,link=https://github.com/antora-supplemental/antora-dark-mode/actions/workflows/deploy.yml]
2020

2121
**Changelog:** link:CHANGELOG.adoc[CHANGELOG.adoc] (summaries) and link:changelog-details/[`changelog-details/`] (dated detail files).
2222

@@ -30,9 +30,6 @@ toc::[]
3030
* **No FOUC (Flash of Unstyled Content)** - Dark mode is applied before page render via inline script
3131
* **Non-invasive** - Works as a supplemental UI overlay; no need to fork or rebuild the Antora default UI bundle
3232
* **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`).
3633
* **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.
3734

3835
== 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
4441

4542
Your support helps the Antora team prioritize this feature!
4643

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+
4746
== Quick Start
4847

4948
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.
5756
----
5857
ui:
5958
bundle:
60-
url: https://github.com/antora-supplemental/antora-dark-theme/releases/download/v1.1.0/ui-bundle.zip
59+
url: https://github.com/antora-supplemental/antora-dark-mode/releases/download/v1.2.0/ui-bundle.zip
6160
snapshot: true
6261
supplemental_files: ./supplemental-ui-overrides
6362
----
@@ -81,7 +80,7 @@ This theme documents three consumer strategies (float `latest`, exact pin, Renov
8180
|===
8281
| Playbook URL | Meaning
8382

84-
| `.../releases/download/v1.1.0/ui-bundle.zip`
83+
| `.../releases/download/v1.2.0/ui-bundle.zip`
8584
| Exact pin (recommended for CI)
8685

8786
| `.../releases/download/v1.0/ui-bundle.zip`
@@ -107,7 +106,7 @@ A YAML list of multiple **directories** is not supported—the array form is onl
107106
----
108107
ui:
109108
bundle:
110-
url: https://github.com/antora-supplemental/antora-dark-theme/releases/download/v1.1.0/ui-bundle.zip
109+
url: https://github.com/antora-supplemental/antora-dark-mode/releases/download/v1.2.0/ui-bundle.zip
111110
snapshot: true
112111
supplemental_files: ./supplemental-ui-overrides
113112
----
@@ -165,7 +164,7 @@ See the dark theme in action: {url-demo}[Live Demo]
165164

166165
[source]
167166
----
168-
antora-dark-theme/
167+
antora-dark-mode/
169168
├── supplemental-ui/
170169
│ ├── css/
171170
│ │ └── site-extra.css # Dark mode CSS styles

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DEPRECATED — do not install
22

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.
44

55
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.
66

@@ -27,11 +27,11 @@ In `antora-playbook.yml`:
2727
```yaml
2828
ui:
2929
bundle:
30-
url: https://github.com/antora-supplemental/antora-dark-theme/releases/download/v1.1.0/ui-bundle.zip
30+
url: https://github.com/antora-supplemental/antora-dark-mode/releases/download/v1.2.0/ui-bundle.zip
3131
snapshot: true
3232
```
3333
34-
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.
3535

3636
### 2. Optional branding (one directory only)
3737

@@ -42,26 +42,26 @@ Pin an exact semver tag for production. See [Version Pinning](https://antora-sup
4242
### 3. Remove this package if it is already installed
4343

4444
```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
4747
```
4848

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`.
5050

5151
---
5252

5353
## Where to find full documentation
5454

5555
| Resource | URL |
5656
|----------|-----|
57-
| **Install guide & lessons learned** | [npm deprecation (Antora site)](https://antora-supplemental.github.io/antora-dark-theme/antora-dark-theme/guide/npm-deprecation.html) |
58-
| **Live demo** | [antora-supplemental.github.io/antora-dark-theme](https://antora-supplemental.github.io/antora-dark-theme) |
57+
| **Install guide & lessons learned** | [npm deprecation (Antora site)](https://antora-supplemental.github.io/antora-dark-mode/antora-dark-mode/guide/npm-deprecation.html) |
58+
| **Live demo** | [antora-supplemental.github.io/antora-dark-mode](https://antora-supplemental.github.io/antora-dark-mode) |
5959
| **Extensions catalog (org hub)** | [antora-supplemental.github.io/docs](https://antora-supplemental.github.io/docs/) |
60-
| **Source repository** | [github.com/antora-supplemental/antora-dark-theme](https://github.com/antora-supplemental/antora-dark-theme) |
61-
| **Example playbook** | [examples/antora-playbook.yml](https://github.com/antora-supplemental/antora-dark-theme/blob/main/examples/antora-playbook.yml) |
60+
| **Source repository** | [github.com/antora-supplemental/antora-dark-mode](https://github.com/antora-supplemental/antora-dark-mode) |
61+
| **Example playbook** | [examples/antora-playbook.yml](https://github.com/antora-supplemental/antora-dark-mode/blob/main/examples/antora-playbook.yml) |
6262

6363
---
6464

6565
## License
6666

67-
[MIT](https://github.com/antora-supplemental/antora-dark-theme/blob/main/LICENSE)
67+
[MIT](https://github.com/antora-supplemental/antora-dark-mode/blob/main/LICENSE)

antora-playbook-local.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# Uses locally cached remote assets when available.
33

44
site:
5-
title: Antora Dark Theme
6-
url: https://antora-supplemental.github.io/antora-dark-theme
7-
start_page: antora-dark-theme:guide:index.adoc
5+
title: Antora Dark Mode
6+
url: https://antora-supplemental.github.io/antora-dark-mode
7+
start_page: antora-dark-mode:guide:index.adoc
88

99
content:
1010
sources:

antora-playbook.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
# Refreshes remote assets before generating the site. Use for CI and deploy.
33

44
site:
5-
title: Antora Dark Theme
6-
url: https://antora-supplemental.github.io/antora-dark-theme
7-
start_page: antora-dark-theme:guide:index.adoc
5+
title: Antora Dark Mode
6+
url: https://antora-supplemental.github.io/antora-dark-mode
7+
start_page: antora-dark-mode:guide:index.adoc
88

99
content:
1010
sources:

antora-registry-topics.json5

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
repository: "https://github.com/antora-supplemental/antora-dark-mode",
3+
githubTopics: [
4+
"antora-extension",
5+
"antora-dark-mode",
6+
],
7+
}

changelog-details/2026-03-26 - 0.1.5 VCS repo logo and npm metadata.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Timeline: link:2026-01-29%20-%200.1.0%20initial%20release.adoc[0.1.0 (2026-01-29
1313

1414
== Documentation
1515

16-
* 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
1717

1818
== Packaging
1919

changelog-details/2026-04-26 - 1.0.3 doc home tiles in supplemental.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
The Antora hub home page uses an open block with class `cards` and example blocks with class `tile`.
44
Styling for `+.openblock.cards+` and `+.exampleblock.tile+` is delivered from `supplemental-ui/css/site-extra.css` so that:
55

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/`.
88
99
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.
1010
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

Comments
 (0)