Jamdesk Documentation logo

Link e navigazione

Collega le pagine, crea ancore verso titoli specifici e fai riferimento a URL esterni. Include la navigazione con Card e il controllo dei link interrotti.

MDX supporta i link Markdown standard. Jamdesk aggiunge pattern per i link alle pagine, le ancore ai titoli e gli 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.

Usa percorsi relativi alla radice della documentazione, senza l'estensione .mdx.

Collegare i titoli

Collega direttamente una sezione tramite link ad ancora:

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

I titoli generano automaticamente le ancore dal proprio 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 in una nuova scheda con impostazioni sicure.

Collegare con le Card

Usa le Card al posto dei link in linea per una navigazione in evidenza:

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

  Get up and running in 5 minutes

</Card>
Quickstart

Inizia in 5 minuti

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

Installa la CLI

Configuration

Configura il progetto

Procedure consigliate

Indica al lettore dove porta il link:

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

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

Collega alla sezione più specifica e pertinente:

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

I link interrotti infastidiscono i lettori. Esegui regolarmente i controlli dei link:

jamdesk broken-links

Questo comando analizza la documentazione e segnala eventuali link interni interrotti.

Controllare i link non validi

La CLI di Jamdesk può analizzare i link interrotti:

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.

Eseguilo prima del deploy per individuare errori di battitura e riferimenti obsoleti.

Correggere automaticamente i link non validi

jamdesk fix ripara un link interrotto che ha un'unica destinazione corretta non ambigua (un'ancora con errore di battitura o uno scostamento di ancore tra lingue, in cui una pagina tradotta ha rinominato i propri titoli):

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

Riscrive un link solo quando l'ancora corretta corrisponde a un titolo reale nella pagina di destinazione. Tutto ciò che è ambiguo viene lasciato per la revisione manuale. Consulta Correzione automatica dei link interrotti.

Come vengono rilevati i link interni

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

I siti che usano hostAtDocs (documentazione ospitata in un sottopercorso come /docs) aggiungono il prefisso /docs ai link interni in fase di esecuzione. Scrivi i percorsi relativi alla radice della documentazione:

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

I link non relativi alla documentazione (come le pagine di marketing) devono usare URL completi: https://example.com/pricing. Qualsiasi link /path nei contenuti della documentazione viene trattato come link interno alla documentazione.

Rinominare le pagine

Rinominare una pagina interrompe i link che vi puntano. Aggiorna ogni riferimento con la CLI:

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

Questo comando:

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

Prossimi passi?

Ottimizzazione SEO

Migliora la reperibilità e i metadati

Frontmatter

Definisci titoli, descrizioni e campi SEO