Comment formater le code dans Markdown

Il existe deux façons de formater le code dans Markdown. Vous pouvez soit utiliser du code en ligne, en mettant des backticks (`) autour de parties d'une ligne, soit vous pouvez utiliser un bloc de code, auquel certains moteurs de rendu appliqueront la coloration syntaxique.

Code en ligne

Vous pouvez utiliser la mise en forme de code en ligne pour mettre en valeur une petite commande ou un morceau de syntaxe dans une ligne que vous écrivez.

Par exemple, vous voudrez peut-être mentionner la Array.protoype.map()méthode JavaScript . En utilisant la mise en forme de code en ligne, il est clair qu'il s'agit d'un morceau de code. Vous pouvez également l'utiliser pour illustrer une commande de terminal, comme yarn install.

Pour utiliser le formatage de code en ligne, enveloppez simplement le code que vous souhaitez formater dans des accents inversés. Sur un clavier QWERTY à disposition américaine standard, il se trouve à gauche de «1» et au-dessus de la touche Tab. Vous trouverez ci-dessous plus d'informations sur l'emplacement du backtick sur les claviers internationaux.

Par exemple, écrire «Array.prototype.map ()» dans markdown sera rendu comme Array.prototype.map().

Blocs de code

Pour écrire des extraits de code plus longs ou plus détaillés, il est souvent préférable de les placer dans un bloc de code. Les blocs de code vous permettent d'utiliser plusieurs lignes, et Markdown le rendra dans sa propre boîte et avec une police de type de code.

Pour y parvenir, commencez votre bloc avec une ligne de trois backticks. Cela signale à Markdown que vous créez un bloc de code. Vous devrez terminer avec une autre ligne de trois backticks. Par exemple:

''

var add2 = fonction (nombre) {

  numéro de retour + 2;

}

''

sera rendu dans le démarquage comme:

var add2 = function(number) { return number + 2; }

Mise en évidence de la syntaxe

Bien qu'ils ne soient pas pris en charge nativement par le démarquage, de nombreux moteurs de démarquage, y compris celui utilisé par GitHub, prendront en charge la coloration syntaxique. Cela signifie qu'en indiquant à Markdown la langue que vous utilisez dans le bloc de code, il ajoutera des couleurs comme le ferait un IDE.

Vous pouvez le faire en ajoutant le nom de la langue sur la même ligne que vos trois premières graduations. Dans l'exemple ci-dessus, si au lieu que la première ligne soit `` `` vous pourriez écrire '' `` js, alors la mise en évidence JavaScript sera appliquée au bloc.

var add2 = function(number) { return number + 2; }

Cependant, la mise en évidence de la syntaxe peut être appliquée à plus que du JavaScript. Vous pouvez utiliser `` html:

Hello World

`` rubis:

"Hello World".split('').each do |letter| puts letter end

ou `` `` python:

a, b = 0, 1 while b < 10: print(b) a, b = a, a + b

N'oubliez pas que tous les moteurs de démarque n'appliqueront pas la coloration syntaxique.

Backticks sur les claviers internationaux

L'emplacement de la touche d'accompagnement peut être différent sur différents claviers, et si vous n'utilisez pas de clavier QWERTY à disposition américaine, il peut être difficile à trouver. Ce guide utile répertorie certaines des façons de trouver votre clé de backtick, que nous avons rassemblées ci-dessous:

QWERTY et QWERTZ:

AZERTY: