Come scrivere un blocco di codice in Markdown:recintalo con tre apici inversi.

Un blocco di codice mantiene la spaziatura, usa un carattere a larghezza fissa e, con il nome di un linguaggio, ottiene i colori della sintassi. Ecco la sintassi dei recinti, i tag del linguaggio e cosa fare quando il codice stesso contiene apici inversi.

macOS 14 o successivo. Leggere è gratis; modificare e revisionare si pagano una volta sola.

Risposta rapida

Metti tre apici inversi sulla riga prima e su quella dopo il codice. Scrivi il linguaggio subito dopo gli apici di apertura per attivare l'evidenziazione della sintassi. Per il codice dentro una frase, racchiudilo tra singoli apici inversi.

```swift
let greeting = "Hello"
print(greeting)
```

·

Blocchi di codice recintati

Un recinto è una riga di almeno tre apici inversi, e il blocco termina con una riga lunga almeno quanto la prima. Tutto ciò che sta in mezzo viene mostrato come scritto: niente grassetto, niente link, niente righe unite.

```
plain text, no colors
  indentation is kept
```

Puoi usare invece tre tilde: ~~~ apre e ~~~ chiude. I due tipi non si mescolano, quindi un blocco aperto con le tilde deve chiudersi con le tilde. Anche rientrare ogni riga di quattro spazi crea un blocco di codice, lo stile più vecchio, ma non può indicare un linguaggio, quindi i recinti sono la scelta migliore.

Tag del linguaggio ed evidenziazione della sintassi

La parola dopo il recinto di apertura è la stringa informativa. La maggior parte delle app la usa per scegliere un evidenziatore:

```json
{ "name": "dotmd", "private": true }
```

Nomi comuni che funzionano su GitHub, in DotMD e nella maggior parte delle altre app:

  • js o javascript, ts o typescript, python, swift, go, rust
  • bash, sh o zsh per i comandi di shell
  • json, yaml, html, css, sql
  • markdown o md per mostrare Markdown stesso, diff per le modifiche, text per nessun colore

L'elenco esatto dei nomi dipende dall'app e dal suo evidenziatore. Un nome che l'app non conosce non è un errore: il blocco viene semplicemente mostrato senza colori. Anche un blocco senza linguaggio viene mostrato in modo semplice.

Mostrare apici inversi dentro un blocco di codice

Se il codice contiene una riga di tre apici inversi, recintalo con più apici. Il recinto di chiusura deve essere lungo almeno quanto quello di apertura, quindi usane quattro per mostrarne tre:

````markdown
```swift
let x = 1
```
````

È così che questa pagina mostra gli esempi Markdown che contengono blocchi di codice. I recinti con tilde funzionano allo stesso modo: un blocco aperto con ~~~~ può contenere ~~~.

Codice in linea

Per un comando o un nome dentro una frase, racchiudilo tra singoli apici inversi: `npm install` dà npm install. Per mostrare un apice inverso, metti tutto tra doppi apici inversi e aggiungi uno spazio all'interno se il codice inizia o finisce con un apice inverso:

``a `tick` inside``

Il codice in linea impedisce anche che caratteri come * e _ vengano letti come formattazione, ed è lo strumento giusto per nomi di file e variabili.

Codice dentro elenchi e citazioni

Un blocco recintato può stare dentro una voce di elenco. Rientra il recinto in linea con il testo della voce, così resta parte della voce:

1. Install the tool:

   ```bash
   brew install example
   ```

2. Run it.

Metti una riga vuota prima del recinto e mantieni ogni riga del codice rientrata della stessa quantità. In una citazione, inizia ogni riga del recinto con >.

Blocchi diff

Contrassegna un blocco con diff e le righe che iniziano con + o - diventano verdi e rosse nelle app che evidenziano i diff, GitHub compreso:

```diff
- let timeout = 30
+ let timeout = 60
```

È un modo comodo per mostrare una modifica in un documento, in un README o in una specifica senza screenshot.

Errori comuni

  • Un recinto di chiusura più corto di quello di apertura: il blocco non finisce mai e inghiotte il resto della pagina.
  • Spazi prima del tag del linguaggio nelle app rigorose. Scrivi ```js, non ``` js, se i colori non compaiono.
  • Mescolare apici inversi e tilde in un solo blocco.
  • Nessuna riga vuota prima del recinto dopo una voce di elenco o un paragrafo, in alcune app. Aggiungine una.
  • Virgolette tipografiche. Il testo incollato da un programma di videoscrittura può trasformare le virgolette dritte nel codice in virgolette tipografiche. Incolla come testo semplice.

Alcuni recinti non servono a mostrare codice. Un blocco contrassegnato mermaid viene disegnato come diagramma da GitHub e da DotMD, purché la sintassi sia valida.

Controllare i colori

Il modo più rapido per provare un tag del linguaggio è aprire il file in un lettore. DotMD colora i blocchi recintati con highlight.js nei temi chiaro e scuro e mostra un pulsante Copy quando passi il cursore su un blocco. La lettura è gratuita, e il cheat sheet Markdown ha il resto della sintassi in una pagina.

Domande sui blocchi di codice in Markdown

Come faccio un blocco di codice in Markdown?

Metti tre apici inversi sulla riga prima e su quella dopo il codice, e facoltativamente il nome del linguaggio dopo gli apici di apertura. Funziona anche un rientro di quattro spazi, ma non può indicare un linguaggio.

Come aggiungo l'evidenziazione della sintassi a un blocco di codice Markdown?

Scrivi il linguaggio subito dopo il recinto di apertura, ad esempio ```python. È l'app a scegliere i colori; un nome che non conosce mostra testo semplice.

Come metto degli apici inversi dentro un blocco di codice Markdown?

Apri e chiudi il blocco con un recinto più lungo di qualsiasi cosa contenga, ad esempio quattro apici inversi attorno a codice che ne contiene tre. Usa i doppi apici inversi per il codice in linea che ne contiene uno.

Che differenza c'è tra ``` e ~~~?

Nessuna nell'aspetto del blocco. Sono entrambi recinti, ma un blocco deve chiudersi con lo stesso carattere con cui si è aperto.

Altre domande