From 89d2b0d4b715ce8ccfeeb332210a33eee9472989 Mon Sep 17 00:00:00 2001 From: Sascha Willems Date: Wed, 9 Sep 2026 17:32:43 +0200 Subject: [PATCH 1/3] Add note on viewing the tutorial in github Fixes #509 --- README.adoc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.adoc b/README.adoc index 867b04fe..88f7e123 100644 --- a/README.adoc +++ b/README.adoc @@ -3,6 +3,11 @@ = Khronos Vulkan^®^ Tutorial +ifndef::site-gen-antora[] +> [!NOTE] +> The tutorial uses the Antora site generator, documentation links might not work when viewed through this git repository. Please use this link:https://docs.vulkan.org/tutorial/latest/00_Introduction.html[this link] to view the tutorial instead. +endif::[] + == Attribution The Khronos Vulkan^®^ Tutorial is based on the "link:https://vulkan-tutorial.com/[Vulkan Tutorial]" by Alexander Overvoorde licensed under link:https://creativecommons.org/licenses/by-sa/4.0/[CC BY-SA 4.0]. From 402eb5499ccac47e1aff78228abfa9f16890be78 Mon Sep 17 00:00:00 2001 From: Sascha Willems Date: Wed, 9 Sep 2026 17:34:35 +0200 Subject: [PATCH 2/3] Use Asciidoc note block syntax --- README.adoc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 88f7e123..003ccacd 100644 --- a/README.adoc +++ b/README.adoc @@ -4,8 +4,9 @@ = Khronos Vulkan^®^ Tutorial ifndef::site-gen-antora[] -> [!NOTE] -> The tutorial uses the Antora site generator, documentation links might not work when viewed through this git repository. Please use this link:https://docs.vulkan.org/tutorial/latest/00_Introduction.html[this link] to view the tutorial instead. +[NOTE] +==== +The tutorial uses the Antora site generator, documentation links might not work when viewed through this git repository. Please use this link:https://docs.vulkan.org/tutorial/latest/00_Introduction.html[this link] to view the tutorial instead. endif::[] == Attribution From 15875818465a6e21c443af5a6f0673230d5e275f Mon Sep 17 00:00:00 2001 From: Sascha Willems Date: Wed, 9 Sep 2026 17:35:30 +0200 Subject: [PATCH 3/3] Use Asciidoc Note syntax --- README.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/README.adoc b/README.adoc index 003ccacd..91e28eee 100644 --- a/README.adoc +++ b/README.adoc @@ -7,6 +7,7 @@ ifndef::site-gen-antora[] [NOTE] ==== The tutorial uses the Antora site generator, documentation links might not work when viewed through this git repository. Please use this link:https://docs.vulkan.org/tutorial/latest/00_Introduction.html[this link] to view the tutorial instead. +==== endif::[] == Attribution