Skip to navigation
Writing contentComponents

GitHub repository

View as Markdown

The <GitHub.Repo> component renders a card that links to a GitHub repository. The card is built from the repo property alone; Fern doesn’t call the GitHub API, so the card shows no star counts or descriptions.

Usage

fern-api/fern
Markdown
<GitHub.Repo repo="fern-api/fern" />

Properties

repo
stringRequired

The repository as owner/name or as a full https://github.com/owner/name URL. The card doesn’t render if the value isn’t a valid repository reference.

variant
'inset' | 'flat'Defaults to inset

flat removes the card’s shadow.