Skip to main content

Maintain the catalog

The site only lists public repositories that already exist under nathanmcnulty and start with azd-.

Add a newly published template​

  1. Publish the repository on GitHub with an azd- prefix.
  2. Add or update its metadata entry in catalog/overrides.json.
  3. Run:
npm run build

The build regenerates src/generated/solutions.ts from GitHub plus your local overrides, and it also rewrites the generated solution guide pages under docs/solutions/.

Why overrides exist​

GitHub repository metadata is not enough for a polished catalog on its own. The overrides file lets you control:

  • display title
  • summary
  • tags
  • featured ordering
  • quickstart commands
  • highlights
  • variant count

Override shape​

{
  "repoName": "azd-example",
  "title": "Example workload",
  "summary": "One-sentence explanation of what the template deploys.",
  "tags": ["Tag One", "Tag Two"],
  "highlights": [
    "Important selling point",
    "Another useful detail"
  ],
  "featured": false,
  "solutionCount": 1,
  "quickstartCommands": [
    "azd init -t nathanmcnulty/azd-example",
    "azd up"
  ]
}

GitHub API notes​

The generator uses the public GitHub API. For a small personal catalog, anonymous access is usually fine. If you want a higher rate limit during local builds or CI, set GITHUB_TOKEN before running the build.