Evidenziazione
L'evidenziazione è una sintassi estesa in Markdown utilizzata per enfatizzare testo importante nei documenti. Aiuta i lettori a identificare rapidamente le informazioni chiave, rendendo i documenti più vivaci ed efficaci.
Sintassi Base
Evidenziare il Testo
Nella maggior parte delle estensioni Markdown che supportano l'evidenziazione, il testo evidenziato è racchiuso da due segni di uguale (==
) attorno al contenuto da evidenziare:
Questo è un esempio di paragrafo che contiene ==testo evidenziato==.
Effetto di Rendering:
Questo è un esempio di paragrafo che contiene ==testo evidenziato==.
Evidenziare Parole e Frasi
L'evidenziazione può essere applicata a singole parole o frasi:
In programmazione, ==variabili== sono spazi nominati per memorizzare dati.
Assicurati di leggere le ==note importanti e avvertenze== nella documentazione.
Effetto di Rendering:
In programmazione, ==variabili== sono spazi nominati per memorizzare dati.
Assicurati di leggere le ==note importanti e avvertenze== nella documentazione.
Uso Avanzato
Combinare con Altri Formati
L'evidenziazione può essere combinata con altri formati Markdown:
==**Evidenziazione in grassetto**==
==*Evidenziazione in corsivo*==
==***Evidenziazione grassetto corsivo***==
==`Evidenziazione codice`==
==[Evidenziazione link](https://www.markdownlang.com)==
Effetto di Rendering:
==Evidenziazione in grassetto==
==Evidenziazione in corsivo==
==Evidenziazione grassetto corsivo==
==Evidenziazione codice
==
Evidenziazione a Livello di Blocco
Alcune implementazioni Markdown permettono di applicare l'evidenziazione a interi contenuti di livello blocco, solitamente usando una sintassi container personalizzata:
::: highlight
Questo è un blocco di paragrafo evidenziato.
Può contenere più righe di contenuto e persino includere elenchi:
- Voce 1
- Voce 2
- Voce 3
:::
Nota: Il supporto all'evidenziazione a livello di blocco varia a seconda del processore Markdown. L'esempio sopra è disponibile su piattaforme come VitePress che supportano container personalizzati.
Compatibilità e Differenze di Implementazione
Stato di Supporto sulle Diverse Piattaforme
Piattaforma/Strumento | Supporto Evidenziazione | Sintassi |
---|---|---|
GitHub Markdown | ❌ | Non supportato |
GitLab Markdown | ✅ | ==evidenzia== |
Hugo | ✅ | Usa tag mark o ==evidenzia== |
VitePress | ✅ | ==evidenzia== |
Pandoc | ✅ | ==evidenzia== o [evidenzia]{.mark} |
Jekyll | ✅ | Dipende dal tema e dai plugin |
CommonMark | ❌ | Non supportato |
Formato Output HTML
La maggior parte dei processori Markdown che supportano l'evidenziazione converte il testo evidenziato in HTML con tag <mark>
o classi CSS specifiche:
<!-- Usando il tag mark -->
<p>Questo è un esempio di paragrafo con <mark>testo evidenziato</mark>.</p>
<!-- Usando una classe personalizzata -->
<p>Questo è un esempio di paragrafo con <span class="highlighted">testo evidenziato</span>.</p>
Sintassi Alternativa
Sulle piattaforme che non supportano la sintassi di evidenziazione, puoi usare i tag HTML come alternativa:
Questo è un esempio di paragrafo con <mark>testo evidenziato</mark>.
<!-- O usando stili personalizzati -->
Questo è un esempio di paragrafo con <span style="background-color: yellow;">testo evidenziato</span>.
Scenari d'Uso
Enfasi nei Documenti
L'evidenziazione è adatta per enfatizzare contenuti importanti nei documenti:
# Guida all'Installazione
Esegui un ==backup completo dei tuoi dati== prima dell'installazione. Il processo di installazione formatterà la partizione di destinazione.
Passaggi di installazione:
1. Scarica l'installer
2. Avvia la procedura guidata
3. ==Seleziona l'opzione "Installazione Personalizzata"==
4. Segui le istruzioni a schermo per completare l'installazione
Effetto di Rendering:
Guida all'Installazione
Esegui un ==backup completo dei tuoi dati== prima dell'installazione. Il processo di installazione formatterà la partizione di destinazione.
Passaggi di installazione:
- Scarica l'installer
- Avvia la procedura guidata
- ==Seleziona l'opzione "Installazione Personalizzata"==
- Segui le istruzioni a schermo per completare l'installazione
Materiale Didattico
L'evidenziazione è particolarmente utile in materiali didattici e di formazione:
## Variabili Python
In Python, l'assegnazione delle variabili usa il simbolo `=`:
```python
x = 10 # Assegna il valore 10 alla variabile x
==Python è un linguaggio tipizzato dinamicamente, dove i tipi delle variabili sono determinati automaticamente durante l'assegnazione.==
Tipi di variabili comuni:
- Intero (int)
- Virgola mobile (float)
- Stringa (str)
- Booleano (bool)
### Confronto e Revisione Testo
L'evidenziazione può essere usata per enfatizzare modifiche o differenze nei documenti:
```markdown
## Confronto Versioni Documento
### Versione Originale
Il server sarà sottoposto a manutenzione ogni domenica alle 2:00 AM.
### Versione Aggiornata
Il server sarà sottoposto a manutenzione ogni domenica alle 2:00 AM. ==La manutenzione durerà circa 2 ore.==
Effetto di Rendering:
Confronto Versioni Documento
Versione Originale
Il server sarà sottoposto a manutenzione ogni domenica alle 2:00 AM.
Versione Aggiornata
Il server sarà sottoposto a manutenzione ogni domenica alle 2:00 AM. ==La manutenzione durerà circa 2 ore.==
Citazioni e Annotazioni
L'evidenziazione può essere usata per marcare punti chiave in un testo citato:
> "Questo è un testo citato, ==dove questa parte è particolarmente importante==, richiedendo particolare attenzione da parte dei lettori."
>
> — Un Autore Famoso
Effetto di Rendering:
"Questo è un testo citato, ==dove questa parte è particolarmente importante==, richiedendo particolare attenzione da parte dei lettori."
— Un Autore Famoso
Personalizzazione dello Stile
Negli ambienti che supportano la personalizzazione CSS, puoi modificare lo stile del testo evidenziato:
/* Stili personalizzati per evidenziazione */
mark, .highlighted {
background-color: #ffeb3b; /* Sfondo giallo */
color: #000; /* Testo nero */
padding: 0 3px; /* Spaziatura */
border-radius: 3px; /* Angoli arrotondati */
}
/* Tipi diversi di evidenziazione */
.highlight-warning {
background-color: #ffcdd2; /* Evidenziazione rossa di avviso */
}
.highlight-success {
background-color: #c8e6c9; /* Evidenziazione verde di successo */
}
Utilizzo di stili personalizzati:
Questo è <mark class="highlight-warning">informazione di avviso</mark>, questo è <mark class="highlight-success">informazione di successo</mark>.
Best Practice
Raccomandazioni d'Uso
✅ Pratiche Consigliate:
1. **Usa l'evidenziazione con moderazione**:
- Evidenzia solo contenuti veramente importanti
- Troppa evidenziazione ne indebolisce l'effetto
2. **Mantieni la coerenza**:
- Usa uno stile di evidenziazione coerente in tutto il documento
- Usa stili diversi per tipi diversi di contenuto importante
3. **Combina con il contesto**:
- Assicurati che il contenuto evidenziato abbia un collegamento logico con il testo circostante
- Puoi aggiungere brevi spiegazioni sul perché un contenuto è evidenziato
❌ Pratiche da Evitare:
1. Evidenziare paragrafi troppo lunghi o interi capitoli
2. Abusare dell'evidenziazione in una sola pagina
3. Evidenziare contenuti poco importanti
4. Usare troppi colori o stili diversi di evidenziazione
Considerazioni sull'Accessibilità
L'evidenziazione può causare difficoltà di lettura per alcuni utenti. Considera i seguenti punti:
- Assicurati che ci sia sufficiente contrasto tra i colori di evidenziazione e lo sfondo
- Non affidarti solo al colore per trasmettere informazioni
- Considera l'aggiunta di marcatori aggiuntivi (come icone o titoli) per i contenuti evidenziati
- Testa la leggibilità del documento in diverse modalità di lettura (come la modalità scura)
Soluzioni ai Problemi Comuni
Evidenziazione Non Visualizzata
Se l'evidenziazione non viene visualizzata correttamente:
- Verifica se la piattaforma supporta la sintassi
==
per l'evidenziazione - Prova a usare i tag HTML
<mark>
come alternativa - Assicurati che non ci siano spazi tra
==
e il testo evidenziato - Controlla che il documento faccia riferimento agli stili CSS corretti
Conflitti con Altri Formati
A volte l'evidenziazione può entrare in conflitto con altri formati:
<!-- Scrittura potenzialmente problematica -->
==**Contenuto [formattato](https://www.markdownlang.com) complesso**==
<!-- Scrittura più sicura -->
<mark>**Contenuto [formattato](https://www.markdownlang.com) complesso**</mark>
Problemi con Evidenziazione a Blocco
Per evidenziare interi blocchi, si consiglia di usare HTML o container personalizzati:
<!-- Usando HTML -->
<div class="highlighted-block">
# Capitolo Importante
Questo è un blocco di contenuto che necessita di evidenziazione generale.
</div>
<!-- O usando container personalizzati (sulle piattaforme supportate) -->
::: highlight
# Capitolo Importante
Questo è un blocco di contenuto che necessita di evidenziazione generale.
:::
Sintassi Correlata
- Enfasi - Sintassi enfasi testo (grassetto, corsivo)
- Citazioni - Sintassi citazioni
- HTML - Uso di HTML in Markdown
Strumenti e Plugin
- markdown-it-mark: Aggiunge il supporto all'evidenziazione per markdown-it
- remark-highlight.js: Aggiunge evidenziazione della sintassi per il codice
- gatsby-remark-highlight-code: Plugin di evidenziazione codice in Gatsby
Sommario
L'evidenziazione è una sintassi estesa efficace che può migliorare la leggibilità e la visibilità delle informazioni chiave nei documenti. Anche se non tutti i processori Markdown supportano nativamente la sintassi di evidenziazione, tramite tag HTML e CSS personalizzati possiamo ottenere effetti simili in quasi ogni ambiente. Un uso ragionevole dell'evidenziazione aiuta i lettori a individuare rapidamente i contenuti importanti, migliorando l'esperienza di lettura complessiva.