Enlaces internos
../api-playground/overview—se rompen cuando las páginas se mueven y son más difíciles de revisar.
Enlaces de anclaje
Enlazar a encabezados en la misma página
Enlazar a encabezados en otras páginas
Cómo Mintlify genera anclajes
| Texto del encabezado | Anclaje generado |
|---|---|
## Getting Started | #getting-started |
### API Authentication | #api-authentication |
#### Step 1: Install | #step-1-install |
Los encabezados con la prop
noAnchor no generan enlaces de anclaje. Consulta Formatear texto para más detalles.IDs de anclaje personalizados
{#custom-id} al texto del encabezado:
#config en lugar de #configuration-options. Los IDs personalizados mantienen los enlaces de anclaje estables cuando actualizas el texto del encabezado—útil para encabezados a los que enlazas frecuentemente. Consulta Formatear texto para más detalles.
Enlaces profundos
Enlaces profundos de acordeón
title del acordeón. Usa la propiedad id para establecer un hash personalizado:
#install en lugar del #installation-steps generado automáticamente. Consulta Acordeones para más información.
Enlaces profundos del API playground
?playground=open a cualquier URL de página de endpoint:
Enlaces externos
Mejores prácticas
Escribe texto de anclaje descriptivo
Enlaza los prerrequisitos explícitamente
Construye clústeres de temas
Verifica los enlaces rotos
Actualiza los enlaces al reorganizar
- Actualiza la ruta de la página en tu configuración de navegación.
- Configura redirecciones de la ruta antigua a la nueva ruta.
- Busca en tu documentación referencias a la ruta antigua.
- Actualiza todos los enlaces internos para usar la nueva ruta.
- Ejecuta
mint broken-linkspara verificar.
Usa redirecciones para contenido movido
Preguntas frecuentes
¿Debo usar rutas relativas a la raíz o URLs absolutas para enlaces internos?
¿Debo usar rutas relativas a la raíz o URLs absolutas para enlaces internos?
Las rutas relativas a la raíz (que comienzan con
/) son la opción correcta para enlaces internos en Mintlify. Funcionan de manera consistente sin importar dónde se encuentre la página que enlaza en tu directorio, y no se rompen si tu dominio de documentación cambia. Las URLs absolutas para enlaces internos crean una fragilidad innecesaria.¿Cómo mantengo estables los enlaces de anclaje cuando actualizo los encabezados?
¿Cómo mantengo estables los enlaces de anclaje cuando actualizo los encabezados?
Usa IDs de anclaje personalizados para los encabezados a los que enlazas frecuentemente. Añadir
{#custom-id} a un encabezado desacopla el anclaje del texto del encabezado, para que puedas actualizar el texto del encabezado sin romper ningún enlace que apunte a él. Esto es especialmente útil para encabezados en secciones de referencia de alto tráfico donde el texto puede necesitar refinamiento con el tiempo.¿Qué pasa con los enlaces marcados cuando reorganizo mi documentación?
¿Qué pasa con los enlaces marcados cuando reorganizo mi documentación?
Sin redirecciones, los enlaces marcados y compartidos se convierten en errores 404. Configura redirecciones en tu
docs.json cada vez que muevas o renombres una página. Las redirecciones son económicas de añadir y evitan una mala experiencia de usuario para cualquiera que haya enlazado a tu documentación desde una fuente externa—publicaciones de blog, respuestas de Stack Overflow, wikis internas.¿Cuántos enlaces internos debe tener una página?
¿Cuántos enlaces internos debe tener una página?
Enlaza cuando un concepto relacionado sea genuinamente útil para el usuario en ese momento—no para cumplir una cuota. Muy pocos enlaces dejan a los usuarios sin contexto o próximos pasos. Demasiados enlaces convierten la página en un ejercicio de navegación que aleja a los usuarios de lo que están tratando de hacer. Como heurística general, enlaza la primera mención de un concepto o herramienta, y no repitas el mismo enlace varias veces en una sola página.
- Formatear texto: Opciones de formato Markdown incluyendo IDs de encabezados y comportamiento de anclajes.
- Navegación: Configura la estructura de tu documentación.
- Redirecciones: Configura redirecciones para contenido movido.