Automad Package Registry

A curated list of Automad packages that can be installed using the dashboard. Currently only packages that contain themes that can be installed using the dashboard are registered here.

Important

This repository is not open to external contributions. Pull requests will not be reviewed or merged.

Adding Packages

In order to add a package to registry, the following three steps are required.

Creating a Public Repository

The theme must be available in a public repository that is supported by Composer.

Registering the Package on Packagist

The public repository must contain a composer.json file and must be registered on packagist.org as a valid Composer package.

Add Entry to JSON Endpoint

Now the package can be added to this registry by adding a JSON formatted object with the following shape to a json endpoint:

[
  {
    "name": "vendor/package",
    "description": "Description text goes here",
    "thumbnail": "https://domain.com/thumbnail.png",
    "repository": "https://github.com/user/repository",
    "issues": "https://github.com/user/repository/issues",
    "documentation": "https://github.com/user/repository/blob/master/README.md",
    "authors": [
      {
        "name": "Author Name",
        "homepage": "https://domain.com"
      }
    ]
  }
]

Important

Please note that the name field must match the package name that is used on Packagist!

Registry Versioning

In order keep the registry stable over time, the JSON endpoints are named by the first Automad release that supports the particular API.