Add to the registry

Made an Antora extension or theme? Here's how to get it listed. Repositories that meet the criteria below can be checked and listed right away; everything else is reviewed by an admin.

Check a repository now

Discovery runs once a day. To skip the wait, paste a GitHub repository URL. If it meets every criterion it's listed immediately; otherwise you'll see what to fix.

Sign in to check a repository.

What qualifies

  • An Antora extension (build-time, CI, generator, utility or site UI) or a complete Antora UI theme.
  • A public GitHub repository that others can install from.
  • Working code with a README that explains what it does and how to install it.
  • An open-source license.

Steps for everyone

  1. Add the GitHub topic antora-extension or antora-theme to your repository (pick one).
  2. Write a README with a short description, install steps and a usage example.
  3. Add a LICENSE file.
  4. Sign in.
  5. Check it with the form above to list it right away, or submit it with the extension or theme form for review.
  6. Submissions from trusted publishers (such as the antora-supplemental organization and its members) are listed without waiting for review.

Themes

  • Commit a preview.png (1280×720) to the root of the default branch. It's the image on your gallery card.
  • Publish a live demo, for example on GitHub Pages, and set it as the repository website.
  • Declare its appearance with topics: antora-light-theme for light only, antora-dark-theme for dark only, both for a theme with light and dark modes, or antora-other-theme for anything else (high contrast, sepia and so on). The gallery filters Light, Dark, Light + dark and Other use these.
  • Or declare it in an antora-theme.json file at the repository root. The file wins over topics, and they must not disagree. appearance is light, dark, both or other.
  • If your theme only swaps the color variables of another theme, name that theme as baseTheme (owner/repo) in the manifest. The card shows it as a color re-theme. A fork alone doesn't count.
{
  "appearance": "dark",
  "baseTheme": "antora-supplemental/valentus-theme",
  "demoUrl": "https://example.github.io/my-theme/"
}

Screenshot workflow

Add this GitHub Action to your theme repository to regenerate preview.png from your live demo:

- name: Generate Preview Screenshot
  uses: simonw/shot-scraper-action@v1
  with:
    url: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/
    output: preview.png
    width: 1280
    height: 720

- name: Commit Screenshot
  run: |
    git config user.name "Preview Bot"
    git config user.email "[email protected]"
    git add preview.png
    git commit -m "Update preview screenshot" || exit 0
    git push

Starting points

  • Valentus: a complete theme with dark mode, good as a reference.
  • Deploy template: an Antora playbook with a GitHub Actions workflow that publishes to Pages.

Extensions

  • Tag the repository antora-extension. Tagged repositories are found once a day; use the check above to list yours sooner.
  • If it adds dark mode to an existing theme, also tag it antora-dark-mode so it's listed under Dark mode add-ons.
  • Optional: add a ui-modules/registry.json5 manifest to list several extensions or bundles from one repository, with their dependencies. See the contributing docs.

After you submit

  • Submissions that aren't checked automatically wait for an admin. Approved entries appear in the registry.
  • Updates: push to your repository. The registry re-reads listed repositories once a day.
  • Removal: delete the topic and open an issue asking us to remove the listing.

Antora Registry — community extensions and themesNot affiliated with or endorsed by the Antora project.