Intestazioni

Le intestazioni organizzano i contenuti e creano ancore di navigazione. Compaiono nel sommario e aiutano gli utenti a scorrere rapidamente la documentazione.

Creazione di intestazioni

Usa i simboli # per creare intestazioni di livelli diversi:
## Intestazione della sezione principale
### Intestazione della sottosezione
#### Intestazione della sotto-sottosezione
Usa intestazioni descrittive e ricche di parole chiave che indichino chiaramente il contenuto che segue. Questo migliora sia la navigazione degli utenti sia il posizionamento sui motori di ricerca.
Per impostazione predefinita, le intestazioni includono link ancora cliccabili che consentono agli utenti di collegarsi direttamente a sezioni specifiche. Puoi disattivare questi link ancora usando la prop noAnchor nelle intestazioni HTML o React.
<h2 noAnchor>
Intestazione senza link ancora
</h2>
Quando si usa noAnchor, l’intestazione non mostrerà il chip dell’ancora e facendo clic sul testo dell’intestazione non copierà il link ancora negli appunti.

Formattazione del testo

Supportiamo la maggior parte della formattazione Markdown per evidenziare e stilizzare il testo.

Formattazione di base

Applica questi stili di formattazione al tuo testo:
StileSintassiEsempioRisultato
Grassetto**text****nota importante**nota importante
Corsivo_text__enfasi_enfasi
Barrato~text~~funzionalità deprecata~funzionalità deprecata

Combinare i formati

Puoi combinare gli stili di formattazione:
**_bold and italic_**
**~~bold and strikethrough~~**
*~~italic and strikethrough~~**
grassetto e corsivo
grassetto e barrato
corsivo e barrato

Apice e pedice

Per espressioni matematiche o note a piè di pagina, utilizza i tag HTML:
TipoSintassiEsempioRisultato
Apice<sup>text</sup>example<sup>2</sup>example2
Pedice<sub>text</sub>example<sub>n</sub>examplen
I link aiutano gli utenti a navigare tra le pagine e ad accedere a risorse esterne. Usa un testo di link descrittivo per migliorare l’accessibilità e l’esperienza utente. Collega ad altre pagine della tua documentazione usando percorsi relativi alla root:
[Quickstart](/quickstart)
[Steps](/components/steps)
Quickstart
Steps
Evita link relativi come [page](../page) perché si caricano più lentamente e non possono essere ottimizzati con la stessa efficacia dei link relativi alla root.
Per le risorse esterne, includi l’URL completo:
[Markdown Guide](https://www.markdownguide.org/)
Markdown Guide Puoi verificare la presenza di link non funzionanti nella tua documentazione usando la CLI:
mint broken-links

Citazioni

Le citazioni mettono in risalto informazioni importanti, citazioni o esempi all’interno dei tuoi contenuti.

Citazioni su una riga

Aggiungi > prima del testo per creare una citazione:
> Questa è una citazione che si distingue dal contenuto principale.
Questa è una citazione che si distingue dal contenuto principale.

Citazioni su più righe

Per citazioni più lunghe o composte da più paragrafi:
> This is the first paragraph of a multi-line blockquote.
>
> This is the second paragraph, separated by an empty line with `>`.
Questo è il primo paragrafo di una citazione su più righe. Questo è il secondo paragrafo, separato da una riga vuota con >.
Usa le citazioni con parsimonia per conservarne l’impatto visivo e il significato. Valuta l’uso dei callouts per note, avvertenze e altre informazioni.

Espressioni matematiche

Supportiamo LaTeX per visualizzare espressioni ed equazioni matematiche.

Matematica in linea

Usa il simbolo del dollaro, $, per le espressioni matematiche in linea:
The Pythagorean theorem states that $(a^2 + b^2 = c^2)$ in a right triangle.
Il teorema di Pitagora afferma che (a2+b2=c2)(a^2 + b^2 = c^2) in un triangolo rettangolo.

Equazioni in blocco

Usa i doppi simboli del dollaro, $$, per le equazioni indipendenti:
$$
E = mc^2
$$
E=mc2E = mc^2
Il supporto LaTeX richiede una sintassi matematica corretta. Consulta la documentazione di LaTeX per linee guida complete sulla sintassi.

Interruzioni di riga e spaziatura

Gestisci spaziatura e interruzioni di riga per migliorare la leggibilità dei contenuti.

Interruzioni di paragrafo

Separa i paragrafi con una riga vuota:
This is the first paragraph.

This is the second paragraph, separated by a blank line.
Questo è il primo paragrafo. Questo è il secondo paragrafo, separato da una riga vuota.

Interruzioni di riga manuali

Usa i tag HTML <br /> per inserire interruzioni di riga forzate all’interno dei paragrafi:
This line ends here.<br />
This line starts on a new line.
Questa riga termina qui.
Questa riga inizia su una nuova riga.
Nella maggior parte dei casi, separare i paragrafi con una riga vuota garantisce una migliore leggibilità rispetto alle interruzioni di riga manuali.

Best practice

Organizzazione dei contenuti

  • Usa le intestazioni per creare una gerarchia dei contenuti chiara
  • Segui una gerarchia corretta delle intestazioni (non passare da H2 a H4)
  • Scrivi intestazioni descrittive e ricche di parole chiave

Formattazione del testo

  • Usa il grassetto per evidenziare, non per interi paragrafi
  • Riserva il corsivo a termini, titoli o per un’enfasi leggera
  • Evita una formattazione eccessiva che distolga dall’effettivo contenuto
  • Usa testi dei link descrittivi invece di “clicca qui” o “leggi di più”
  • Usa percorsi relativi alla root per i link interni
  • Controlla regolarmente i link per evitare collegamenti interrotti