DotMDComment écrire un bloc de code en Markdown :le délimiter par trois accents graves.
Un bloc de code garde vos espacements, utilise une police à chasse fixe et, avec un nom de langage, reçoit la coloration syntaxique. Voici la syntaxe des délimiteurs, les langages et que faire quand le code contient lui-même des accents graves.
macOS 14 ou ultérieur. La lecture est gratuite ; l’édition et les relectures se paient en une fois.
Réponse rapide
Mettez trois accents graves sur la ligne avant et après le code. Écrivez le langage juste après les accents graves d’ouverture pour activer la coloration syntaxique. Pour du code dans une phrase, entourez-le d’accents graves simples.
```swift
let greeting = "Hello"
print(greeting)
```·
Blocs de code délimités
Un délimiteur est une ligne d’au moins trois accents graves, et le bloc se termine par une ligne d’au moins la même longueur. Tout ce qui est entre les deux s’affiche tel que tapé : pas de gras, pas de liens, pas de jonction de lignes.
```
plain text, no colors
indentation is kept
```Vous pouvez utiliser trois tildes à la place : ~~~ ouvre et ~~~ ferme. Les deux types ne se mélangent pas : un bloc ouvert avec des tildes doit se fermer avec des tildes. Indenter chaque ligne de quatre espaces fait aussi un bloc de code, à l’ancienne, mais il ne peut pas porter de nom de langage ; les délimiteurs sont donc le meilleur choix.
Langages et coloration syntaxique
Le mot après le délimiteur d’ouverture est la chaîne d’info. La plupart des applications s’en servent pour choisir un colorateur :
```json
{ "name": "dotmd", "private": true }
```Noms courants qui marchent dans GitHub, DotMD et la plupart des autres applications :
jsoujavascript,tsoutypescript,python,swift,go,rustbash,shouzshpour les commandes shelljson,yaml,html,css,sqlmarkdownoumdpour montrer du Markdown lui-même,diffpour des modifications,textpour aucune couleur
La liste exacte des noms dépend de l’application et de son colorateur. Un nom que l’application ne connaît pas n’est pas une erreur : le bloc s’affiche simplement sans couleurs. Un bloc sans langage s’affiche aussi en texte simple.
Montrer des accents graves dans un bloc de code
Si le code contient une ligne de trois accents graves, délimitez-le avec davantage. Le délimiteur de fermeture doit être au moins aussi long que celui d’ouverture : utilisez-en quatre pour en montrer trois :
````markdown
```swift
let x = 1
```
````C’est ainsi que cette page montre des exemples de Markdown qui contiennent des blocs de code. Les délimiteurs en tildes fonctionnent de la même façon : un bloc ouvert avec ~~~~ peut contenir ~~~.
Code en ligne
Pour une commande ou un nom dans une phrase, entourez-le d’accents graves simples : `npm install` donne npm install. Pour montrer un accent grave, mettez le tout entre deux accents graves doubles et ajoutez une espace à l’intérieur si le code commence ou finit par un accent grave :
``a `tick` inside``Le code en ligne empêche aussi des caractères comme * et _ d’être lus comme de la mise en forme, ce qui en fait l’outil idéal pour les noms de fichiers et les variables.
Du code dans des listes et des citations
Un bloc délimité peut se trouver dans un élément de liste. Indentez le délimiteur pour l’aligner sur le texte de l’élément, afin qu’il reste dans l’élément :
1. Install the tool:
```bash
brew install example
```
2. Run it.Mettez une ligne vide avant le délimiteur et gardez chaque ligne de code indentée de la même quantité. Dans une citation, commencez chaque ligne du délimiteur par >.
Blocs diff
Marquez un bloc diff et les lignes qui commencent par + ou - sont colorées en vert et en rouge dans les applications qui colorent les diffs, dont GitHub :
```diff
- let timeout = 30
+ let timeout = 60
```C’est une façon pratique de montrer une modification dans une doc, un README ou une spec sans capture d’écran.
Erreurs courantes
- Un délimiteur de fermeture plus court que celui d’ouverture : le bloc ne se termine jamais et avale le reste de la page.
- Des espaces avant le langage dans les applications strictes. Écrivez
```js, pas``` js, si les couleurs n’apparaissent pas. - Mélanger accents graves et tildes dans un même bloc.
- Pas de ligne vide avant le délimiteur après un élément de liste ou un paragraphe dans certaines applications. Ajoutez-en une.
- Des guillemets typographiques. Du texte collé depuis un traitement de texte peut transformer les guillemets droits du code en guillemets courbes. Collez en texte brut.
Certains délimiteurs ne servent pas à montrer du code. Un bloc marqué mermaid est dessiné comme un diagramme par GitHub et par DotMD, tant que la syntaxe est valide.
Vérifier les couleurs
Le moyen le plus rapide de tester un langage est d’ouvrir le fichier dans un lecteur. DotMD colore les blocs délimités avec highlight.js en thème clair et sombre et affiche un bouton Copy quand vous survolez un bloc. La lecture est gratuite, et l’aide-mémoire Markdown réunit le reste de la syntaxe sur une page.
Questions sur les blocs de code en Markdown
Comment faire un bloc de code en Markdown ?
Mettez trois accents graves sur la ligne avant et après le code, et si vous voulez le nom du langage après les accents graves d’ouverture. Quatre espaces d’indentation marchent aussi, mais ne peuvent pas porter de langage.
Comment ajouter la coloration syntaxique à un bloc de code Markdown ?
Écrivez le langage juste après le délimiteur d’ouverture, par exemple ```python. L’application choisit les couleurs ; un nom qu’elle ne connaît pas affiche du texte simple.
Comment mettre des accents graves dans un bloc de code Markdown ?
Ouvrez et fermez le bloc avec un délimiteur plus long que tout ce qu’il contient, par exemple quatre accents graves autour d’un code qui en contient trois. Utilisez des accents graves doubles pour du code en ligne qui en contient un.
Quelle est la différence entre ``` et ~~~ ?
Aucune dans l’aspect du bloc. Les deux sont des délimiteurs, mais un bloc doit se fermer avec le même caractère que celui avec lequel il s’est ouvert.