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
docs: sync READMEs and add stacked overrides guide
- Updated README.md with Method 1 (Pre-built bundle) for NPM users
- Added Method 4: Stacked Overrides to both README.md and README.adoc
- Improved clarity of installation methods for better developer experience
To override the dark theme's own overrides with your project-specific customizations, use an array for `supplemental_files`. Paths listed later take precedence.
Copy file name to clipboardExpand all lines: README.md
+36-1Lines changed: 36 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,28 @@ yarn add -D antora-dark-theme
23
23
bun add -d antora-dark-theme
24
24
```
25
25
26
-
Then configure your playbook file(s) (typically `antora-playbook.yml`) to load the supplemental UI from `node_modules`:
26
+
Then configure your playbook file(s) (typically `antora-playbook.yml`) to use the theme.
27
+
28
+
### Method 1: Use pre-built bundle (Recommended)
29
+
30
+
The easiest way to use this theme is to point your Antora playbook directly to the latest pre-built UI bundle. This includes the Antora Default UI plus all dark mode enhancements without requiring any local package installation.
To override the dark theme's own overrides with your project-specific customizations, use an array for `supplemental_files`. Paths listed later take precedence.
0 commit comments