Submitting Your Theme

Once your theme meets the requirements, you can submit it to the gallery.

Before You Submit

Verify that:

Test your screenshot URL:

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

Creating an Account

  1. Go to the Antora Themes Gallery

  2. Click Sign up or Sign in

  3. Choose your preferred method:

    • GitHub - Recommended for theme developers

    • GitLab - If your theme is on GitLab

    • Google - General purpose

    • Email - For privacy-conscious users

Submitting

  1. Navigate to the Submit page (/submit)

  2. Enter your GitHub repository URL:

    https://github.com/yourusername/my-antora-theme

  3. Click btn:[Validate Theme]

    The system will verify:

    • Repository exists and is public

    • Can fetch repository metadata

    • Preview image is accessible

  4. Review the preview and click btn:[Submit Theme for Review]

Review Process

After submission, your theme enters the review queue:

Status Meaning

Pending

Your theme is waiting for review

Approved

Your theme is visible in the public gallery

Rejected

Your theme didn’t meet requirements (you’ll be notified why)

Review typically takes 1-3 business days.

After Approval

Once approved, your theme will:

  • Appear in the gallery browse page

  • Be searchable by name, description, and tags

  • Show your GitHub star count (updated periodically)

  • Link directly to your demo and repository

Updating Your Theme

You don’t need to resubmit when you update your theme:

  • Preview site - Automatically updates when you push to GitHub

  • Screenshot - Regenerated by your GitHub Action

  • Star count - Periodically fetched from GitHub API

  • Description - Pulled from your repository description

To update theme metadata (name, tags), you may need to contact an administrator.

Removing Your Theme

To remove your theme from the gallery:

  1. Make your repository private, OR

  2. Contact an administrator

FAQ

  1. Can I submit a theme hosted on GitLab?

    Currently, we only support GitHub-hosted themes. GitLab support is planned.

  2. How long does review take?

    Typically 1-3 business days. We review for spam and basic quality.

  3. Can I submit multiple themes?

    Yes! Each theme needs its own repository.

  4. My theme was rejected. What now?

    Check the rejection reason in your notification. Common issues:

    • Screenshot missing or wrong size

    • Demo site not working

    • Repository is private

    • Not actually an Antora theme

  5. How do I update my theme’s description?

    Update your GitHub repository description. The gallery syncs this periodically.