Enlaces y navegación

MDX admite enlaces estándar de Markdown además de patrones específicos de Jamdesk para enlazar entre páginas, anclar a encabezados y referenciar URLs externas.

Enlaces internos

Enlaza a otras páginas de tu documentación usando rutas relativas:

Read the [getting started guide](/quickstart) first.

See the [Card component](/components/card) for more options.

Enlazar a encabezados

Enlaza directamente a una sección usando enlaces de anclaje:

See [configuration options](/config/docs-json-reference#colors)

Los encabezados generan anclajes automáticamente a partir de su texto:

• ## Getting Started → #getting-started
• ## API Reference → #api-reference

Enlaces externos

Enlaza a sitios externos:

Check the [GitHub repository](https://github.com/example/repo).

Los enlaces externos se abren automáticamente en una pestaña nueva con configuración segura.

Enlazar con Cards

Para navegación destacada, usa Cards en lugar de enlaces en línea:

<Card title="Quickstart" icon="rocket" href="/quickstart">

  Get up and running in 5 minutes

</Card>

Grupos de Cards

Agrupa enlaces relacionados:

<Columns cols={2}>
  <Card title="Installation" icon="download" href="/cli/overview">

    Install the CLI

</Card>
  <Card title="Configuration" icon="gear" href="/config/docs-json-reference">

    Configure your project

</Card>
</Columns>

Buenas prácticas

{/* Good */}
Learn more in our [authentication guide](/quickstart).

{/* Avoid */}
For more info, [click here](/quickstart).

{/* Good - links to specific section */}
Configure [OAuth settings](/quickstart#whats-next).

{/* Less helpful - links to entire page */}
See the [auth docs](/quickstart) for OAuth settings.

jamdesk broken-links

Comprobar enlaces rotos

La CLI de Jamdesk puede analizar enlaces rotos:

jamdesk broken-links

Ejemplo de salida:

docs/getting-started.mdx:15 - /docs/quikstart
  Did you mean: /docs/quickstart

Found 1 broken link in 45 files.

Ejecuta esto antes de desplegar para detectar erratas y referencias desactualizadas.

Corregir enlaces rotos automáticamente

Cuando un enlace roto tiene un destino correcto inequívoco (un anclaje con errata, o una desviación de anclaje entre idiomas donde una página traducida renombró sus encabezados), jamdesk fix lo repara por ti:

jamdesk fix --dry-run   # preview every planned fix, write nothing
jamdesk fix             # apply after a y/N confirmation

Solo reescribe un enlace cuando el anclaje corregido es un encabezado real en la página de destino, dejando cualquier caso ambiguo para revisión manual. Consulta Corregir enlaces rotos automáticamente.

Cómo se detectan los enlaces internos

Los enlaces sin https:// se tratan como internos y se validan contra las páginas de tu documentación. El validador comprueba que la página de destino exista en la navegación de tu docs.json.

Para sitios que usan hostAtDocs (documentación alojada en una subruta como /docs), los enlaces internos se prefijan automáticamente en tiempo de ejecución. Escribe rutas relativas a la raíz de tu documentación; el prefijo /docs se añade automáticamente:

{/* Just write the docs path — auto-prefixed to /docs/config/docs-json-reference */}
See the [Reference](/config/docs-json-reference).

Renombrar páginas

Cuando renombras una página, los enlaces se rompen. Usa la CLI para actualizar todas las referencias:

jamdesk rename api/old-name.mdx api/new-name.mdx

Esto automáticamente:

• Renombra el archivo
• Actualiza la navegación de docs.json
• Corrige los enlaces en todas las demás páginas

¿Qué sigue?