Skip to content

Commit c291311

Browse files
committed
docs: add local site generation intructions
1 parent c71392b commit c291311

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.adoc

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,59 @@ This script uses vcpkg to install the required dependencies, including:
6161

6262
You will also need to install the Vulkan SDK separately from https://vulkan.lunarg.com/.
6363

64+
== Generating the Site Locally
65+
66+
This tutorial's site is generated using link:https://antora.org/[Antora],
67+
a multi-repository documentation site generator. If you want to generate the
68+
site locally then:
69+
70+
. Install link:https://github.com/nvm-sh/nvm[npm] and optionally install
71+
`Antora` (you can use `npx` instead)
72+
73+
. Assuming you are in the repository's root directory, fetch the Khronos
74+
Antora UI bundle and build it:
75+
+
76+
[source,bash]
77+
----
78+
git clone https://github.com/KhronosGroup/antora-ui-khronos.git
79+
cd antora-ui-khronos/
80+
npx update-browserslist-db@latest
81+
./node_modules/gulp/bin/gulp.js bundle
82+
----
83+
+
84+
. Copy the generated UI bundle into the repository's root directory:
85+
+
86+
[source,bash]
87+
----
88+
cd ../
89+
cp ./antora-ui-khronos/build/ui-bundle.zip ./
90+
----
91+
+
92+
. Then configure the Khronos Vulkan Samples Antora tree:
93+
+
94+
[source,bash]
95+
----
96+
cd antora/
97+
make
98+
----
99+
+
100+
. And navigate back to the repository's root folder and run:
101+
+
102+
[source,bash]
103+
----
104+
cd ../
105+
antora antora-ci-playbook.yml --stacktrace
106+
----
107+
+
108+
Or in case you don't have antora installed, you can also:
109+
+
110+
[source,bash]
111+
----
112+
npx antora antora-ci-playbook.yml --stacktrace
113+
----
114+
+
115+
. The generated site's index HTML should be accessible at: build/site/index.html
116+
64117
== License
65118

66119
The contents of this repository are licensed as https://creativecommons.org/licenses/by-sa/4.0/[CC BY-SA 4.0], unless stated otherwise.

0 commit comments

Comments
 (0)