Enlaces y Navegación

MDX admite enlaces Markdown estándar más 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.

Usa rutas relativas a la raíz de tu documentación, sin la extensión .mdx.

Enlazar a encabezados

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

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

Los encabezados generan automáticamente anclajes 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 nueva pestaña con configuraciones seguras.

Enlaces con Cards

Para una 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>

Quickstart

Empieza a funcionar en 5 minutos

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>

Instalación

Instala el CLI

Configuración

Configura tu proyecto

Buenas prácticas

Indica a los lectores a dónde lleva el enlace:

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

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

Enlaza a la sección más específica y relevante:

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

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

Los enlaces rotos frustran a los lectores. Ejecuta verificaciones de enlaces regularmente:

jamdesk broken-links

Esto analiza tu documentación e informa cualquier enlace interno roto.

Verificación de enlaces rotos

El CLI de Jamdesk puede analizar en busca de 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 errores tipográficos y referencias desactualizadas.

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 verifica 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).

Los enlaces que no son de documentación (como páginas de marketing) deben usar URLs completas: https://example.com/pricing. Cualquier enlace /ruta en el contenido de tu documentación se trata como un enlace interno de documentación.

Renombrar páginas

Cuando renombras una página, los enlaces se rompen. Usa el 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?

Optimización SEO

Mejora la visibilidad y los metadatos

Frontmatter

Define títulos, descripciones y campos SEO