Skip to content
Mintlify
Mintlify
Composants

GitHub

Utilisez le composant GitHub pour intégrer une carte de dépôt affichant en direct la description, le nombre d'étoiles et de forks dans votre documentation.

Utilisez le composant <GitHub.Repo> pour intégrer une carte qui renvoie vers un dépôt GitHub public. La carte récupère la description du dépôt, le nombre d’étoiles et de forks depuis l’API publique de GitHub au chargement de la page.

Indiquez un dépôt sous la forme d’un slug owner/name ou d’une URL GitHub complète.

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

Choisissez entre les mises en page inset et flat pour vous adapter à la page environnante.

La variante par défaut. Elle encapsule les détails du dépôt dans une surface intérieure arrondie.

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

Une mise en page à surface unique avec un espacement plus resserré. Utilisez flat lorsque vous placez la carte à côté d’autres éléments avec bordure.

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

Le dépôt GitHub à afficher. Accepte un slug owner/name (par exemple, mintlify/docs) ou une URL GitHub complète (par exemple, https://github.com/mintlify/docs).

variantstringdefault: inset

Mise en page de la carte.

Options : inset, flat.

classNamestring

Classes CSS supplémentaires appliquées à la carte.

Was this page helpful?Suggest editsRaise issue