Skip to main content
Use the <GitHub.Repo> component to embed a card that links to a public GitHub repository. The card fetches the repository’s description, star count, and fork count from the public GitHub API when the page loads.

Basic repository card

Pass a repository as either an owner/name slug or a full GitHub URL.

Variants

Choose between the inset and flat layouts to match the surrounding page.

Inset

The default variant. Wraps the repository details in a rounded inner surface.

Flat

A single-surface layout with tighter padding. Use flat when embedding the card next to other bordered elements.

Properties

string
The GitHub repository to display. Accepts an owner/name slug (for example, mintlify/docs) or a full GitHub URL (for example, https://github.com/mintlify/docs).
string
default:"inset"
Card layout.Options: inset, flat.
string
Additional CSS classes to apply to the card.