Enlaces y navegación

MDX admite enlaces estándar de Markdown 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 anclas:

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

Los encabezados generan anclas 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 ajustes seguros.

Enlazar con Cards

Para una navegación más 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>

Inicio rápido

Ponte en marcha 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 la CLI

Configuración

Configura tu proyecto

Buenas prácticas

Indica al lector 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 específica más 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 comprobaciones de enlaces con regularidad:

jamdesk broken-links

Esto analiza tu documentación y reporta cualquier enlace interno roto.

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.

Ejecútalo antes de desplegar para detectar erratas 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 comprueba que la página 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 reciben un prefijo automáticamente en tiempo de ejecución. Escribe las rutas relativas a la raíz de tu documentación — el prefijo /docs se añade por ti:

{/* 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 /path dentro del 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 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 en 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