Link e navigazione

MDX supporta i link Markdown standard e i pattern specifici di Jamdesk per collegare le pagine, creare ancoraggi ai titoli e usare URL esterni.

Link interni

Collega altre pagine della documentazione usando percorsi relativi:

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

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

Collegare i titoli

Collega direttamente a una sezione usando i link con ancoraggio:

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

I titoli generano automaticamente ancoraggi dal relativo testo:

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

Link esterni

Collega siti esterni:

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

I link esterni si aprono automaticamente in una nuova scheda con impostazioni di sicurezza.

Collegare con le Card

Per una navigazione in evidenza, usa le Card invece dei link inline:

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

  Get up and running in 5 minutes

</Card>

Gruppi di Card

Raggruppa i link correlati:

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

Procedure consigliate

{/* 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

Controllare i link non validi

La CLI di Jamdesk può analizzare i link non validi:

jamdesk broken-links

Output di esempio:

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

Found 1 broken link in 45 files.

Esegui questo comando prima del deploy per individuare refusi e riferimenti obsoleti.

Correggere automaticamente i link non validi

Quando un link non valido ha una destinazione corretta non ambigua (un refuso in un ancoraggio o una modifica dell'ancoraggio tra impostazioni locali, quando una pagina tradotta ha rinominato i propri titoli), jamdesk fix lo corregge automaticamente:

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

Riscrive un link solo quando l'ancoraggio corretto corrisponde a un titolo reale nella pagina di destinazione, lasciando al controllo manuale gli elementi ambigui. Vedi Correggere automaticamente i link non validi.

Come vengono rilevati i link interni

I link senza https:// vengono trattati come interni e verificati rispetto alle pagine della documentazione. Il validatore controlla che la pagina di destinazione esista nella navigazione di docs.json.

Per i siti che usano hostAtDocs (documentazione ospitata in un sottopercorso come /docs), i link interni ricevono automaticamente il prefisso durante l'esecuzione. Scrivi i percorsi relativi alla radice della documentazione; il prefisso /docs viene aggiunto automaticamente:

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

Rinominare le pagine

Quando rinomini una pagina, i link si interrompono. Usa la CLI per aggiornare tutti i riferimenti:

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

Questa operazione:

• Rinomina il file
• Aggiorna la navigazione di docs.json
• Corregge i link in tutte le altre pagine

Prossimi passi?