mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
dbfcd5a748
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
70 lines
2.0 KiB
Plaintext
70 lines
2.0 KiB
Plaintext
---
|
|
title: "GitHub"
|
|
description: "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."
|
|
keywords: ["github", "repo", "repositorio", "estrellas", "forks"]
|
|
boost: 3
|
|
tag: "New"
|
|
---
|
|
|
|
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.
|
|
|
|
<div id="basic-repository-card">
|
|
## Tarjeta básica de repositorio
|
|
</div>
|
|
|
|
Indica un repositorio como slug `owner/name` o como URL completa de GitHub.
|
|
|
|
<GitHub.Repo repo="mintlify/docs" />
|
|
|
|
```mdx react
|
|
<GitHub.Repo repo="mintlify/docs" />
|
|
```
|
|
|
|
<div id="variants">
|
|
## Variantes
|
|
</div>
|
|
|
|
Elige entre los diseños `inset` y `flat` para adaptarte a la página que rodea la tarjeta.
|
|
|
|
<div id="inset">
|
|
### Inset
|
|
</div>
|
|
|
|
La variante por defecto. Envuelve los detalles del repositorio en una superficie interna redondeada.
|
|
|
|
<GitHub.Repo repo="mintlify/docs" variant="inset" />
|
|
|
|
```mdx
|
|
<GitHub.Repo repo="mintlify/docs" variant="inset" />
|
|
```
|
|
|
|
<div id="flat">
|
|
### Flat
|
|
</div>
|
|
|
|
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" />
|
|
|
|
```mdx
|
|
<GitHub.Repo repo="mintlify/docs" variant="flat" />
|
|
```
|
|
|
|
<div id="properties">
|
|
## Propiedades
|
|
</div>
|
|
|
|
<ResponseField name="repo" type="string">
|
|
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`).
|
|
</ResponseField>
|
|
|
|
<ResponseField name="variant" type="string" default="inset">
|
|
Diseño de la tarjeta.
|
|
|
|
Opciones: `inset`, `flat`.
|
|
</ResponseField>
|
|
|
|
<ResponseField name="className" type="string">
|
|
Clases CSS adicionales que se aplican a la tarjeta.
|
|
</ResponseField>
|