Skip to content

Commit 6fe6221

Browse files
committed
fixed release URL in example using github URL
1 parent a4fb6ba commit 6fe6221

2 files changed

Lines changed: 21 additions & 17 deletions

File tree

README.adoc

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,23 @@ Your support helps the Antora team prioritize this feature!
3737

3838
== Quick Start
3939

40-
=== Method 1: Copy supplemental-ui folder
40+
=== Method 1: Use pre-built bundle (Recommended)
4141

42-
The simplest approach is to copy the `supplemental-ui` folder into your Antora documentation project.
42+
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.
43+
44+
. Configure your `antora-playbook.yml` to use the release bundle:
45+
+
46+
[source,yaml]
47+
----
48+
ui:
49+
bundle:
50+
url: https://github.com/the-dev-center/antora-dark-theme/releases/latest/download/ui-bundle.zip
51+
snapshot: true
52+
----
53+
54+
=== Method 2: Copy supplemental-ui folder
55+
56+
If you want to customize the dark mode styles or logic locally, you can copy the `supplemental-ui` folder into your project.
4357

4458
. Copy the `supplemental-ui` folder to your project root:
4559
+
@@ -48,7 +62,7 @@ The simplest approach is to copy the `supplemental-ui` folder into your Antora d
4862
cp -r supplemental-ui /path/to/your/antora-project/
4963
----
5064

51-
. Configure your `antora-playbook.yml` to use the supplemental files:
65+
. Configure your `antora-playbook.yml` to use the supplemental files alongside the default UI:
5266
+
5367
[source,yaml]
5468
----
@@ -59,16 +73,9 @@ ui:
5973
supplemental_files: ./supplemental-ui
6074
----
6175

62-
. Build your site:
63-
+
64-
[source,bash]
65-
----
66-
antora antora-playbook.yml
67-
----
68-
69-
=== Method 2: Use as npm dependency
76+
=== Method 3: Use as npm dependency
7077

71-
You can also install this theme as a dev dependency:
78+
You can also install this theme as a dev dependency. This is useful for version tracking and easy updates within your project's ecosystem.
7279

7380
[tabs]
7481
====

examples/antora-playbook.yml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,9 @@ content:
1919

2020
ui:
2121
bundle:
22-
# Use the official Antora default UI bundle
23-
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
22+
# Use the pre-built Antora Dark Theme bundle
23+
url: https://github.com/the-dev-center/antora-dark-theme/releases/latest/download/ui-bundle.zip
2424
snapshot: true
25-
# If using npm: ./node_modules/antora-dark-theme/supplemental-ui
26-
# If copied directly: ./supplemental-ui
27-
supplemental_files: ./node_modules/antora-dark-theme/supplemental-ui
2825

2926
output:
3027
dir: ./build/site

0 commit comments

Comments
 (0)