Skip to content

Commit 97a3570

Browse files
committed
Add Antora files
1 parent ae7abee commit 97a3570

File tree

3 files changed

+10
-7
lines changed

3 files changed

+10
-7
lines changed

.github/workflows/antora-deploy.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ jobs:
2828
uses: actions/setup-node@v4
2929
with:
3030
node-version: '20'
31+
cache: 'npm'
3132
- name: Install Dependencies
32-
run: npm ci
33+
run: npm install
3334
- name: Generate Site
34-
run: npx antora antora-playbook.yml
35+
run: npx antora --fetch antora-playbook.yml
3536
- name: Upload Artifacts
3637
uses: actions/upload-pages-artifact@v3
3738
with:

Makefile

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ROOT_DIR=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
22

33
# Rule to build everything after cleaning
4-
all: install clean ui antora
4+
all: install clean build serve
55

66
# Rule to install dependencies
77
install:
@@ -13,12 +13,14 @@ clean:
1313
rm -rf build
1414

1515
# Rule to build the Antora documentation
16-
antora:
16+
build:
1717
@echo "Building documentation"
1818
cd $(ROOT_DIR) && npm i
1919
cd $(ROOT_DIR) && npx antora --fetch local-antora-playbook.yml
20-
cd $(ROOT_DIR) && npx http-server build/site -c-1
21-
@echo "Antora site is up"
20+
21+
serve:
22+
@echo "Serving documentation"
23+
cd $(ROOT_DIR) && npx serve build/site
2224

2325
# Rule to show help message
2426
help:

README.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ This is an https://antora.org/[Antora] documentation website, available at https
99

1010
== Usage
1111

12-
. `make preview` to launch a "live preview" version of the documentation.
12+
. `make serve` to launch a "live preview" version of the documentation.
1313

0 commit comments

Comments
 (0)