Document that .nojekyll file is required when publishing to GitHub Pages
When publishing an Antora site to GitHub Pages, it's necessary to an empty file to the root directory named .nojekyll
. The existence of this file tells GitHub Pages not to run the published files through Jekyll. This is important since Jekyll will discard any files that begin with _
. By default, Antora puts the UI files in a directory named _
, which Jekyll then erases. As a result, no UI. Antora also puts assets in folders that begin with _
, so no images either.
Adding .nojekyll
is just a good practice anyway since you don't want GitHub Pages altering your published files.