Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,11 @@ jobs:
run: |
make setup_tutorial

- name: "build test site"
# This should be a separate step from the overall site build, just here ATM for testing
working-directory: docs-site
run: npx antora uitest.yml --to-dir build/uitest --stacktrace

- name: "prepare repos with make (parallel)"
run: |
if [[ "${{ (github.event.inputs.Include_GLSL || 'true') != 'false' }}" == "true" ]]; then make prep-glsl & fi
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,9 @@ export CI = true
build-site:
cd docs-site && npx antora antora-playbook.yml --cache-dir .antora-cache

build-uitest:
cd docs-site && npx antora --to-dir build/uitest uitest.yml --stacktrace

# Clean Antora site (but not prepared component sources)
clean:
rm -rf docs-site/build/site
Expand Down
35 changes: 35 additions & 0 deletions docs-site/uitest.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Copyright 2026 The Khronos Group Inc.
# SPDX-License-Identifier: Apache-2.0

site:
title: Khronos Antora UI Test Project
start_page: spec::index.adoc
content:
# Do not include 'Edit this Page' link per
# https://docs.antora.org/antora/latest/playbook/content-edit-url/#disable-edit-u
edit_url: ~
sources:
- url: ..
branches: HEAD
start_paths: docs-site/uitest/spec
antora:
extensions:
- require: '@antora/lunr-extension'
index_latest_only: true

asciidoc:
extensions:
# We use a slightly modified version of the @djencks/asciidoctor-mathjax
# package, adding AMS macro support to the base MathJax configuration.
# This has been sent back upstream in
# https://gitlab.com/djencks/asciidoctor-mathjax.js/-/merge_requests/10
- ./js/asciidoctor-mathjax.js
ui:
bundle:
# We build our own bundle from this repository.
# The Khronos UI is forked from the Antora default UI.
url: ui-bundle.zip
# Supplemental UI - everything under this path is overlaid on the default
# bundle.
# This is only for testing quickly without rebuilding the bundle.
# supplemental_files: ./supplemental-ui
13 changes: 13 additions & 0 deletions docs-site/uitest/spec/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Copyright 2026 The Khronos Group Inc.
# SPDX-License-Identifier: Apache-2.0

name: spec
title: Khronos Antora UI Test
version: latest
# stem (latexmath) support is provided by the @djencks/asciidoctor-mathjax
# extension, loaded in the playbook.
asciidoc:
attributes:
stem: latexmath
nav:
- modules/ROOT/nav.adoc
4 changes: 4 additions & 0 deletions docs-site/uitest/spec/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Copyright 2026 The Khronos Group Inc.
# SPDX-License-Identifier: Apache-2.0

* xref:page.adoc[UI test page]
7 changes: 7 additions & 0 deletions docs-site/uitest/spec/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
// Copyright 2026 The Khronos Group Inc.
// SPDX-License-Identifier: Apache-2.0

= Spec Index

This is xref:index.adoc[] in the 'spec' component
Also see xref:page.adoc[page.adoc]
37 changes: 37 additions & 0 deletions docs-site/uitest/spec/modules/ROOT/pages/page.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Copyright 2026 The Khronos Group Inc.
// SPDX-License-Identifier: Apache-2.0

:data-uri:
:!icons:
:attribute-missing: warn

= Khronos Antora UI Test Page

This page tries to exercise UI elements used in the Khronos Vulkan
Documentation Project, allowing a quick way of reviewing UI changes without
building the entire, enormous site.

== Unbroken

stem:[\sqrt{ -1 }]

[stem]
++++
\sqrt{ i \times i }
++++

* latexmath:[\left\lfloor i_G \times 0.5 \right\rfloor = i_B = i_R]

== Broken

stem:[\sqrt{
-1 }]

[stem]
++++
\sqrt{ i
\times i }
++++

* latexmath:[\left\lfloor i_G \times 0.5
\right\rfloor = i_B = i_R]
Loading