Skip to content

Umbraco Marketplace

The Umbraco Marketplace is where Umbraco users discover packages. The listing is controlled by two files in the repo root.

Controls the listing metadata. Key fields to maintain:

FieldPurposeNotes
TitleDisplay name on marketplaceCurrently “UmBootstrap”
VersionSpecificPackageIdsMaps Umbraco versions to package IDsAdd a new entry for each major Umbraco version
AuthorDetailsAuthor info and contributorsSyncContributorsFromRepository auto-pulls from GitHub
ScreenshotsListing imagesURLs to images (use raw GitHub URLs)
DocumentationUrlLink to docs sitePoints to the Starlight docs
IssueTrackerUrlLink to issue trackerPoints to GitHub Issues

Rendered as the package description on the marketplace. The marketplace checks for this file in the repo root — if not found, it falls back to the NuGet package README.

The marketplace README has specific constraints:

  • It must include a warning that the marketplace install buttons don’t support dotnet new template packages — users must follow the CLI or Visual Studio instructions instead
  • Keep it in sync with README.md (the GitHub version), adding marketplace-specific warnings where needed
  • Images must use absolute URLs (raw GitHub URLs from the develop branch)

See READMEs for the full picture of how the three READMEs are managed.

The marketplace checks for updates automatically:

CheckInterval
New packagesEvery 24 hours (0400 UTC)
Package info refreshEvery 2 hours
Download countsEvery 1 hour

No manual step is needed after publishing to NuGet.

Use the marketplace validation tool to:

  • Check your umbraco-marketplace.json is valid before publishing
  • Force a sync if you don’t want to wait for the automatic interval