Open-source project
The project as its code host shows it: owner and name, the description, then language, license, version and the install command.
The open-source project template draws a repository the way a code host presents it: the owner and project name, a description, and a row of facts for language, license, version and the install command. A link to a repo, a README or a project site previews as a real project card.
Only the repository name and the description are required. Language, license, version and install command are optional, so a young project can show what it has and leave the rest out. The install command, such as npm install kitepath, is shown on the card, which lets people see how to get started before they click. The account logo can fill the brand-mark slot.
Generate one card per repository from your package metadata at build time, or request it from a GET URL in your docs site head. It suits libraries, command-line tools, plugins and framework projects that want a recognisable preview on social platforms, in chat apps and on documentation sites.
- Libraries and SDKs
- Command-line tools
- Plugins and framework extensions
- Project documentation sites
Related: Quickstart · URL templates guide · Next.js guide · API reference
This template renders your account logo (Dashboard → Brand logo) in its brand-mark slot.
Parameters
| Parameter | Type | Required | Limit |
|---|---|---|---|
repo | string | Yes | up to 120 characters |
description | string | Yes | up to 300 characters |
language | string | No | up to 120 characters |
license | string | No | up to 120 characters |
version | string | No | up to 120 characters |
install | string | No | up to 120 characters |
Try it
POST /v1/images, Bearer-authenticated, with this template id and
params — see the quickstart for how to get a key, and for a
signed-URL example that links straight to a cacheable, cache-forever image URL without a
server round trip.
curl https://ogmake.com/v1/images \
-H "Authorization: Bearer og_live_..." \
-H "Content-Type: application/json" \
-d '{
"template": "repo",
"params": {
"repo": "wrenfield/kitepath",
"description": "A small routing library for edge functions",
"language": "TypeScript",
"license": "MIT",
"version": "v2.3.0",
"install": "npm install kitepath"
}
}'
