Requirements

To be listed in the Antora Themes Gallery, your theme must meet these requirements.

Required

Requirement Details

Public Repository

Your theme must be in a public GitHub repository

Live Demo

A working preview site hosted on GitHub Pages (or similar)

Preview Screenshot

A preview.png file in your repository root

Repository Structure

Your repository should be a valid Antora UI theme with at minimum:

your-theme/
├── src/
│   ├── css/
│   ├── js/
│   ├── layouts/
│   ├── partials/
│   └── helpers/
├── preview.png          (1)
├── gulpfile.js
└── package.json
1 Screenshot at repository root

Screenshot Specifications

The preview screenshot should:

  • Be named exactly preview.png

  • Be located in the repository root (main branch)

  • Be 1280×720 pixels (16:9 aspect ratio)

  • Show your theme’s main documentation page

The gallery fetches your screenshot from:

https://raw.githubusercontent.com/{owner}/{repo}/main/preview.png

Demo Site Requirements

Your live demo should:

  • Be publicly accessible

  • Show actual documentation content (not just "Hello World")

  • Demonstrate key UI elements:

    • Navigation sidebar

    • Table of contents

    • Code blocks with syntax highlighting

    • Tables

    • Admonitions (NOTE, TIP, WARNING, etc.)

Use our template repository which includes sample content showcasing all UI elements.

Optional but Recommended

  • README - Explain how to use and customize your theme

  • LICENSE - Specify how others can use your theme

  • Versioning - Use semantic versioning and git tags

  • Topics - Add antora, antora-ui, documentation topics to your repo