How to

Welcome to the Orchard Core Gallery.

This site lists modules and themes made for Orchard Core.

If you own an Orchard Core module or theme, you can submit it.

How to submit a module or theme

1. Fork the OrchardCMS/OrchardCore.Extensions repository.
2. Add one Markdown .md file for your listing:
   • Modules go under modules/{author}.
   • Themes go under themes/{author}.
3. Use the frontmatter format below.
4. Submit a Pull Request to the main repository.

The {author} folder is the GitHub account — user or organization — that publishes the module or theme. Write it exactly as it appears on GitHub.

If you already have listings in the repository, reuse the folder you used before instead of creating a second one for the same owner.

The folder name is independent from author.name. author.name is the display name shown on the site, so it may contain spaces and differ from the GitHub account. For example, the Lombiq folder holds listings whose author.name is Lombiq Technologies.

For example, a module listing can look like this:

---
title: CookieConsent # Title
description: A cookie consent module for Orchard Core. # Short description displayed in lists
dependencies: ["OrchardCore.ContentFields"] # Optional. Direct Orchard Core/package dependencies
projectUrl: https://github.com/agriffard/CookieConsent.OrchardCore # Optional. Project URL, such as a GitHub repository
documentationUrl: https://docs.orchardcore.net/ # Optional. Documentation site URL for the module or theme
nuGetPackageId: CookieConsent.OrchardCore # Optional. NuGet package ID
tags:
  - cookies
  - privacy
author:
  name: Antoine Griffard # Required. Author, company, team, or GitHub username
  url: https://github.com/agriffard # Optional. Company, team, or GitHub profile URL
  imageUrl: https://avatars.githubusercontent.com/u/703248 # Required. Author avatar/logo URL
licenses: [MIT] # Optional. List of available licenses
compatibleWithAllVersions: true # Optional. Marks a listing as compatible with every Orchard Core version (use for core modules/themes)
versions: # Optional. Supported Orchard Core versions
  - 2.0.x # Accepts an exact version (2.0.0) or a wildcard (2.0 / 2.0.x / 2.x) that covers every matching patch
  - 1.8.4
pubDatetime: 2024-09-15T12:00:00Z # Required. Publication date
canonicalURL: https://example.com/cookieconsent # Optional. Canonical URL override
---

A cookie consent module using [cookieconsent](https://github.com/brainsum/cookieconsent).

Supported properties

The Markdown body below the frontmatter is the long description shown on the detail page.

Author pages and URL paths

The gallery automatically creates author pages from author.name. You do not need to add an author path manually in the Markdown file.

Choose one author name and reuse it for all modules and themes from the same owner:

• If the module or theme belongs to a company or team, use that company or team name, such as CrestApps, Lombiq Technologies, or EtchUK.
• If it is not published by a company or team, use your GitHub username or personal author name.

Using the same author.name is important because the gallery groups all matching modules and themes under the same author page.

The author URL path is created from author.name by lowercasing it and replacing spaces with dashes. Words are never split apart, so CrestApps becomes crestapps. This applies to the generated URL only — it does not change the folder name you use in the repository, which stays the GitHub account name.

For example:

author:
  name: CrestApps

generates this author page:

/authors/crestapps/

More examples:

For example, every CrestApps module and theme should use:

author:
  name: CrestApps

so they all appear together at /authors/crestapps/.

After adding your file, submit a Pull Request. The PR will be reviewed before it appears on the site.