Skip to content
Mintlify
Mintlify
Componentes

GitHub

Usa el componente GitHub para incrustar una tarjeta de repositorio con la descripción, el número de estrellas y de forks en vivo en tu documentación.

Usa el componente <GitHub.Repo> para incrustar una tarjeta que enlace a un repositorio público de GitHub. La tarjeta obtiene la descripción del repositorio, el número de estrellas y de forks desde la API pública de GitHub cuando la página se carga.

Indica un repositorio como slug owner/name o como URL completa de GitHub.

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

Elige entre los diseños inset y flat para adaptarte a la página que rodea la tarjeta.

La variante por defecto. Envuelve los detalles del repositorio en una superficie interna redondeada.

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

Un diseño de una sola superficie con menos margen interno. Usa flat cuando incrustes la tarjeta junto a otros elementos con borde.

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

El repositorio de GitHub que se va a mostrar. Acepta un slug owner/name (por ejemplo, mintlify/docs) o una URL completa de GitHub (por ejemplo, https://github.com/mintlify/docs).

variantstringdefault: inset

Diseño de la tarjeta.

Opciones: inset, flat.

classNamestring

Clases CSS adicionales que se aplican a la tarjeta.

Was this page helpful?Suggest editsRaise issue