Markdown Guide des blocs de code: code en ligne, blocs clôturés et mise en évidence de la syntaxe

La mise en forme du code est l'une des caractéristiques les plus fortes de Markdown. Que vous documentiez une fonction, que vous montriez une commande de terminal ou que vous écriviez un tutoriel, la syntaxe du code Markdown maintient le code visuellement distinct. correctement formaté, et (sur la plupart des plateformes) syntaxiquement mis en évidence. Ce guide couvre tout ce qui concerne Blocs de code Markdown.

Code en ligne

Envelopper un court extrait ou une seule expression dans un seul backtick:

Use `console.log()` to print output.
Set the variable with `const x = 42;`.
The file is saved as `README.md`.

Le code en ligne rend dans une police monospace, visuellement distincte du texte environnant. Utilisez-le pour:

• Nom de la fonction et de la méthode: addEventListener()
• Nom des variables: isLoading
• Nom de fichier: package.json
• Arguments de commande: --verbose
• Expressions de code courtes

Si votre code en ligne contient un backtick, utilisez des double backticks pour l'envelopper:

`` `backtick inside` ``

Blocs de code clôturés

Pour le code à plusieurs lignes, utiliser le triple backtick (`) pour ouvrir et fermer le bloc:

```
This is a code block.
It preserves all whitespace and line breaks.
No formatting is applied inside.
```

L'indentation, l'espacement et les nouvelles lignes sont conservées exactement.

Mise en évidence de la syntaxe

Ajouter un identifiant de langue après l'ouverture des triple backticks pour activer la mise en évidence de la syntaxe:

```python
def greet(name: str) -> str:
    return f"Hello, {name}!"

print(greet("World"))
```

```javascript
const greet = (name) => `Hello, ${name}!`;
console.log(greet("World"));
```

```bash
#!/bin/bash
echo "Hello, World!"
ls -la ~/Documents
```

Identificateurs de langue commune

Blocs de codes à l'intérieur

Une syntaxe Markdown plus ancienne utilise l'indentation à 4 espaces pour les blocs de code:

    function oldStyle() {
        return "This is a code block";
    }

Il est compatible avec CommonMark mais moins lisible et ne supporte pas les identifiants de langue. Au lieu de cela, utilisez des blocs clôturés (trois backticks).

Conversion de code à partir de documents Word

Le texte monospace dans Word (Courier New, Consolas, etc.) est converti en code en ligne lorsque vous utilisez WordToMD. Multi-line code in Word converts depending on how it was formatted:

• Paragraphe de police monospace → Peut devenir plusieurs extraits de code en ligne
• Word Code style → Conversion en bloc de code
• Bloc de texte littéral → Peut nécessiter une clôture manuelle

Après la conversion, vérifiez les sections de code et ajoutez une clôture appropriée si nécessaire:

1. Trouver le code qui devrait être un bloc
2. Enveloppez-le avec des tripes
3. Ajouter l'identifiant de langue approprié

Exemples spécifiques à la langue

Demandes HTTP

```http
POST /api/users HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer TOKEN

{
  "name": "Alice",
  "email": "alice@example.com"
}
```

Commandes de terminal

```bash
npm install
npm run build
npm run dev
```

Différence de sortie

```diff
- const oldValue = "hello";
+ const newValue = "world";
  console.log(newValue);
```

Configuration de YAML

```yaml
server:
  host: localhost
  port: 8080
  debug: true
database:
  url: postgresql://localhost:5432/mydb
```

Blocs de code imbriqués (pour la documentation)

Lors de la documentation Markdown elle-même, utilisez 4 backticks pour envelopper un bloc qui contient 3 backticks:

````markdown
```python
# This is a code block inside documentation
```
````

Soutien à la plateforme

Numéros de ligne

Le standard Markdown ne supporte pas les numéros de ligne dans les blocs de code. Certaines plateformes et générateurs de sites statiques l'ajoutent via des plugins:

• Prism.js (utilisé par de nombreux SSG) ajouter {numberLines: true} dans la clôture de code
• GitHub pas de numéros de ligne natifs dans Markdown rendu (utilisez GitHub vue de blâme à la place)
• GitBook numéros de ligne via les paramètres du bloc de code

Copie du code à partir de blocs

GitHub et de nombreuses plateformes ajoutent automatiquement un bouton Copy aux blocs de code. Ceci est une amélioration de rendu il ne nécessite rien de spécial dans votre Markdown.

FAQ

Pourquoi ma syntaxe de bloc de code n'est pas mise en évidence ? Soit l'identifiant de la langue est manquant, soit il est mal orthographié, soit la plateforme ne supporte pas la langue spécifique. Vérifiez la liste d'identifiants ci-dessus.

Comment afficher les backticks à l'intérieur d'un bloc de code ? À l'intérieur d'un bloc de code clôturé, les backticks sont traités comme des caractères littéraux. Seule la clôture à trois épaules nécessite une manipulation spéciale.

Mon document Word avait un code syntaxique coloré mis en surbrillance. Les couleurs seront-elles préservées ? Les blocs de code de démarrage ne conservent pas le formatage des couleurs. WordToMD convertit le texte en un bloc de code; La syntaxe mise en évidence est ensuite appliquée par le rendu Markdown basé sur l'identifiant de la langue.

Puis-je mettre en évidence des lignes spécifiques dans un bloc de code ? La norme Markdown ne supporte pas cela. Certaines plateformes (comme Astro avec Shiki, ou Hugo) soutiennent la ligne en soulignant par le biais de commentaires: {1,3-5} après l'identifiant de la langue.

Des guides connexes

• Markdown Syntaxe aide-mémoire Référence complète
• Word à API Documentation Documentaire lourdement codé
• Pour les personnes âgées, les conditions suivantes sont réunies: GitHub - formatage du code spécifique

Conclusion de l'enquête

Les blocs de code de démarrage sont simples: backticks pour le code en ligne, triple backticks avec un identifiant de langue pour les blocs. Après avoir converti un document Word avec WordToMD, vérifier que le texte monospace a été correctement enveloppé dans la syntaxe du code, et ajouter des identifiants de langue pour une syntaxe appropriée sur votre plateforme cible.