GitHub

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.

<GitHub.Repo repo="mintlify/docs" />

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.

<GitHub.Repo repo="mintlify/docs" variant="inset" />

Flat

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

<GitHub.Repo repo="mintlify/docs" variant="flat" />

Properties