mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
6d2ace8440
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
216 lines
7.0 KiB
Plaintext
216 lines
7.0 KiB
Plaintext
---
|
|
title: "Enlaces"
|
|
description: "Aprende a crear enlaces internos, referenciar endpoints de API y mantener la integridad de los enlaces en toda tu documentación."
|
|
keywords: ["enlaces internos", "referencias cruzadas", "enlaces de anclaje", "enlaces rotos"]
|
|
---
|
|
|
|
El uso eficaz de los enlaces crea una experiencia de documentación conectada que ayuda a los usuarios a descubrir contenido relacionado y navegar de manera eficiente. Demasiados enlaces o enlaces rotos pueden confundir a los usuarios y hacer que tu documentación sea menos efectiva. Esta guía explica cómo crear y mantener enlaces en toda tu documentación.
|
|
|
|
<div id="internal-links">
|
|
## Enlaces internos
|
|
</div>
|
|
|
|
Enlaza a otras páginas de tu documentación usando rutas relativas a la raíz. Las rutas relativas a la raíz comienzan en la raíz de tu directorio de documentación y funcionan de manera consistente sin importar dónde se encuentre la página que enlaza.
|
|
|
|
```mdx
|
|
* [Guía de inicio rápido](/quickstart)
|
|
* [Descripción general de API](/api-playground/overview)
|
|
* [Componentes personalizados](/customize/react-components)
|
|
```
|
|
|
|
* [Guía de inicio rápido](/es/quickstart)
|
|
* [Información general sobre la API](/es/api-playground/overview)
|
|
* [Componentes personalizados](/es/customize/react-components)
|
|
|
|
<div id="anchor-links">
|
|
## Enlaces de ancla
|
|
</div>
|
|
|
|
Los enlaces de ancla te permiten vincular directamente a secciones específicas de una página. Cada encabezado genera automáticamente un enlace de ancla a partir de su texto.
|
|
|
|
<div id="link-to-headers-on-the-same-page">
|
|
### Enlazar a encabezados en la misma página
|
|
</div>
|
|
|
|
Haz referencia a encabezados de la página actual usando el símbolo #:
|
|
|
|
```mdx
|
|
[Ir a las mejores prácticas](#best-practices)
|
|
```
|
|
|
|
[Ir a las prácticas recomendadas](#best-practices)
|
|
|
|
<div id="link-to-headers-on-other-pages">
|
|
### Enlazar encabezados en otras páginas
|
|
</div>
|
|
|
|
Combina las rutas de las páginas con enlaces de ancla.
|
|
|
|
```mdx
|
|
* [Personaliza tu playground](/api-playground/overview#customize-your-playground)
|
|
* [Cards properties](/components/cards#properties)
|
|
```
|
|
|
|
* [Personaliza tu entorno de pruebas](/es/api-playground/overview#customize-your-playground)
|
|
* [Propiedades de las tarjetas](/es/components/cards#properties)
|
|
|
|
<div id="how-anchor-links-are-generated">
|
|
### Cómo se generan los enlaces de anclaje
|
|
</div>
|
|
|
|
Los enlaces de anclaje se generan automáticamente a partir del texto del encabezado.
|
|
|
|
* Convertir a minúsculas
|
|
* Reemplazar espacios con guiones
|
|
* Eliminar caracteres especiales
|
|
* Conservar números y letras
|
|
|
|
| Texto del encabezado | Enlace de anclaje |
|
|
|-------------|-------------|
|
|
| `## Getting Started` | `#getting-started` |
|
|
| `### API Authentication` | `#api-authentication` |
|
|
| `#### Step 1: Install` | `#step-1-install` |
|
|
|
|
<Note>
|
|
Los encabezados con la propiedad `noAnchor` no generarán enlaces de anclaje. Consulta [Formatear texto](/es/create/text#disabling-anchor-links) para obtener más detalles.
|
|
</Note>
|
|
|
|
<div id="link-to-api-endpoints">
|
|
## Enlazar endpoints de la API
|
|
</div>
|
|
|
|
Al documentar una API, puedes enlazar endpoints específicos desde cualquier parte de tu documentación.
|
|
|
|
Enlaza las páginas de endpoints de la API usando su ruta en la navigation.
|
|
|
|
<div id="link-to-external-pages">
|
|
## Enlazar a páginas externas
|
|
</div>
|
|
|
|
Cuando enlaces a recursos externos, asegúrate de que quede claro que el enlace dirige fuera de tu documentación.
|
|
|
|
```mdx
|
|
Learn more about [Markdown syntax](https://www.markdownguide.org/) (external link).
|
|
|
|
Consulta la [especificación de OpenAPI](https://swagger.io/specification/) en la documentación de Swagger para obtener más detalles.
|
|
```
|
|
|
|
<div id="best-practices">
|
|
## Mejores prácticas
|
|
</div>
|
|
|
|
<div id="write-descriptive-link-text">
|
|
### Redacta texto de enlace descriptivo
|
|
</div>
|
|
|
|
Usa texto claro y descriptivo que indique qué encontrarán los usuarios al hacer clic.
|
|
|
|
<CodeGroup>
|
|
```mdx Buenos ejemplos
|
|
Consulta [Páginas ocultas](/organize/hidden-pages) para obtener más información.
|
|
[Configura dominios personalizados](/customize/custom-domain)
|
|
```
|
|
|
|
```mdx Evita
|
|
[Haz clic aquí](/api-playground/overview)
|
|
[Leer más](/deploy/deployments)
|
|
[Ver esta página](/customize/custom-domain)
|
|
```
|
|
</CodeGroup>
|
|
|
|
<div id="create-topic-clusters">
|
|
### Crea agrupaciones de temas
|
|
</div>
|
|
|
|
Enlaza contenido relacionado para ayudar a los usuarios a encontrar información relevante.
|
|
|
|
```mdx
|
|
## Temas relacionados
|
|
|
|
- [Autenticación de API](/api-playground/overview#authentication)
|
|
- [Agregar ejemplos de SDK](/api-playground/adding-sdk-examples)
|
|
- [Gestionar la visibilidad de páginas](/api-playground/managing-page-visibility)
|
|
```
|
|
|
|
<div id="use-contextual-links">
|
|
### Utiliza enlaces contextuales
|
|
</div>
|
|
|
|
Añade enlaces de forma natural dentro del contenido cuando aporten valor.
|
|
|
|
```mdx
|
|
Para personalizar la apariencia de tu documentación, configura los [temas](/customize/themes)
|
|
y las [fuentes](/customize/fonts) en tu configuración. También puedes añadir
|
|
[scripts personalizados](/customize/custom-scripts) para funcionalidad avanzada.
|
|
```
|
|
|
|
<div id="link-to-prerequisites">
|
|
### Enlaza a los requisitos previos
|
|
</div>
|
|
|
|
Ayuda a los usuarios a prepararse añadiendo enlaces al contenido de requisitos previos:
|
|
|
|
```mdx
|
|
## Requisitos previos
|
|
|
|
Antes de desplegar tu documentación, asegúrate de haber:
|
|
|
|
- Completado la [guía de inicio rápido](/quickstart)
|
|
- Configurado tu [dominio personalizado](/customize/custom-domain)
|
|
- Configurado la [autenticación](/deploy/authentication-setup) si es necesario
|
|
```
|
|
|
|
<div id="avoid-circular-links">
|
|
### Evita los enlaces circulares
|
|
</div>
|
|
|
|
No crees enlaces que hagan que los usuarios vayan y vengan entre las mismas páginas.
|
|
|
|
<div id="check-for-broken-links">
|
|
### Comprueba si hay enlaces rotos
|
|
</div>
|
|
|
|
Usa la CLI de Mintlify para identificar enlaces rotos en tu documentación.
|
|
|
|
```bash
|
|
mint broken-links
|
|
```
|
|
|
|
<div id="update-links-when-reorganizing">
|
|
### Actualiza los enlaces al reorganizar
|
|
</div>
|
|
|
|
Al mover o renombrar páginas:
|
|
|
|
1. Actualiza la ruta de la página en tu configuración de navigation.
|
|
2. Configura redirecciones desde la ruta antigua a la nueva.
|
|
3. Busca en tu documentación referencias a la ruta antigua.
|
|
4. Actualiza todos los enlaces internos para que apunten a la nueva ruta.
|
|
5. Ejecuta `mint broken-links` para comprobar que todos los enlaces funcionan correctamente.
|
|
|
|
<div id="use-redirects-for-moved-content">
|
|
### Usa redirecciones para el contenido que se haya movido
|
|
</div>
|
|
|
|
Cuando muevas contenido de forma permanente, añade redirecciones para evitar enlaces rotos.
|
|
|
|
```json
|
|
{
|
|
"redirects": [
|
|
{
|
|
"source": "/old-path",
|
|
"destination": "/new-path"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Para obtener más información, consulta [Redirecciones](/es/create/redirects).
|
|
|
|
<div id="related-resources">
|
|
## Recursos relacionados
|
|
</div>
|
|
|
|
* [Formato de texto](/es/create/text): Más información sobre el formato en Markdown.
|
|
* [Navegación](/es/organize/navigation): Configura la estructura de tu documentación.
|
|
* [Redirecciones](/es/create/redirects): Configura redirecciones para el contenido que se haya movido. |