Skip to main content
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. 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. 
* [Guía de inicio rápido](/quickstart)
* [Descripción general de API](/api-playground/overview)
* [Componentes personalizados](/customize/react-components)
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.

​
Enlazar a encabezados en la misma página

Haz referencia a encabezados de la página actual usando el símbolo #: 
[Ir a las mejores prácticas](#best-practices)
Ir a las prácticas recomendadas Combina las rutas de las páginas con enlaces de ancla. 
* [Personaliza tu playground](/api-playground/overview#customize-your-playground)
* [Cards properties](/components/cards#properties)
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 encabezadoEnlace de anclaje
## Getting Started#getting-started
### API Authentication#api-authentication
#### Step 1: Install#step-1-install
Los encabezados con la propiedad noAnchor no generarán enlaces de anclaje. Consulta Formatear texto para obtener más detalles.
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. Cuando enlaces a recursos externos, asegúrate de que quede claro que el enlace dirige fuera de tu documentación. 
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.

​
Mejores prácticas

​
Redacta texto de enlace descriptivo

Usa texto claro y descriptivo que indique qué encontrarán los usuarios al hacer clic. 
Consulta [Páginas ocultas](/organize/hidden-pages) para obtener más información.
[Configura dominios personalizados](/customize/custom-domain)

​
Crea agrupaciones de temas

Enlaza contenido relacionado para ayudar a los usuarios a encontrar información relevante. 
## 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)
Añade enlaces de forma natural dentro del contenido cuando aporten valor. 
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.
Ayuda a los usuarios a prepararse añadiendo enlaces al contenido de requisitos previos: 
## 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
No crees enlaces que hagan que los usuarios vayan y vengan entre las mismas páginas. Usa la CLI de Mintlify para identificar enlaces rotos en tu documentación. 
mint broken-links
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.

​
Usa redirecciones para el contenido que se haya movido

Cuando muevas contenido de forma permanente, añade redirecciones para evitar enlaces rotos. 
{
  "redirects": [
    {
      "source": "/old-path",
      "destination": "/new-path"
    }
  ]
}
Para obtener más información, consulta Redirecciones.
  • Formato de texto: Más información sobre el formato en Markdown.
  • Navegación: Configura la estructura de tu documentación.
  • Redirecciones: Configura redirecciones para el contenido que se haya movido.