Skip to content

Commit d1cfdcc

Browse files
committed
feat: Add Getting Started and Installation guides, enabling the Asciidoctor Tabs extension.
1 parent 1168b6c commit d1cfdcc

5 files changed

Lines changed: 83 additions & 4 deletions

File tree

antora-playbook.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ output:
2222
dir: ./build/site
2323

2424
asciidoc:
25+
extensions:
26+
- "@asciidoctor/tabs"
2527
attributes:
2628
source-highlighter: highlight.js
2729
icons: font

docs/modules/guide/pages/index.adoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,30 @@ It layers on top of the https://gitlab.com/antora/antora-ui-default[Antora Defau
1818

1919
The fastest way to get started:
2020

21+
[tabs]
22+
====
23+
pnpm::
24+
+
2125
[source,bash]
2226
----
2327
pnpm add -D github:the-dev-center/antora-dark-theme
2428
----
2529
30+
npm::
31+
+
32+
[source,bash]
33+
----
34+
npm install --save-dev github:the-dev-center/antora-dark-theme
35+
----
36+
37+
yarn::
38+
+
39+
[source,bash]
40+
----
41+
yarn add -D github:the-dev-center/antora-dark-theme
42+
----
43+
====
44+
2645
Then add to your `antora-playbook.yml`:
2746

2847
[source,yaml]

docs/modules/guide/pages/installation.adoc

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ There are several ways to add the dark theme to your Antora project.
88

99
Install directly from the GitHub repository:
1010

11+
[tabs]
12+
====
13+
pnpm::
14+
+
1115
[source,bash]
1216
----
1317
# Latest version
@@ -17,13 +21,21 @@ pnpm add -D github:the-dev-center/antora-dark-theme
1721
pnpm add -D github:the-dev-center/antora-dark-theme#v0.1.0
1822
----
1923
20-
Or with npm:
21-
24+
npm::
25+
+
2226
[source,bash]
2327
----
2428
npm install --save-dev github:the-dev-center/antora-dark-theme
2529
----
2630
31+
yarn::
32+
+
33+
[source,bash]
34+
----
35+
yarn add -D github:the-dev-center/antora-dark-theme
36+
----
37+
====
38+
2739
Then configure your `antora-playbook.yml`:
2840

2941
[source,yaml]
@@ -39,24 +51,60 @@ ui:
3951

4052
If the package is published to npm:
4153

54+
[tabs]
55+
====
56+
pnpm::
57+
+
4258
[source,bash]
4359
----
4460
pnpm add -D antora-dark-theme
45-
# or
61+
----
62+
63+
npm::
64+
+
65+
[source,bash]
66+
----
4667
npm install --save-dev antora-dark-theme
4768
----
4869
70+
yarn::
71+
+
72+
[source,bash]
73+
----
74+
yarn add -D antora-dark-theme
75+
----
76+
====
77+
4978
Same playbook configuration as Method 1.
5079

5180
== Method 3: Install from Release Tarball
5281

5382
Download a specific release directly:
5483

84+
[tabs]
85+
====
86+
pnpm::
87+
+
5588
[source,bash]
5689
----
5790
pnpm add -D https://github.com/the-dev-center/antora-dark-theme/releases/download/v0.1.0/antora-dark-theme-0.1.0.tgz
5891
----
5992
93+
npm::
94+
+
95+
[source,bash]
96+
----
97+
npm install --save-dev https://github.com/the-dev-center/antora-dark-theme/releases/download/v0.1.0/antora-dark-theme-0.1.0.tgz
98+
----
99+
100+
yarn::
101+
+
102+
[source,bash]
103+
----
104+
yarn add -D https://github.com/the-dev-center/antora-dark-theme/releases/download/v0.1.0/antora-dark-theme-0.1.0.tgz
105+
----
106+
====
107+
60108
== Method 4: Copy supplemental-ui Folder
61109

62110
For maximum control, copy the `supplemental-ui` folder directly into your project:

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,14 @@
2626
"clean": "rimraf build .cache"
2727
},
2828
"devDependencies": {
29-
"@antora/lunr-extension": "^1.0.0-alpha.8",
29+
"@asciidoctor/tabs": "^1.0.0-beta.6",
3030
"antora": "^3.1.14",
3131
"http-server": "^14.1.1",
3232
"rimraf": "^6.0.1"
3333
},
3434
"packageManager": "pnpm@10.28.1",
3535
"dependencies": {
36+
"@asciidoctor/tabs": "1.0.0-beta.6",
3637
"biome": "^0.3.3"
3738
}
3839
}

pnpm-lock.yaml

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)