Blocs de code Markdown

Les blocs de code sont essentiels pour la documentation technique, les tutoriels et tout contenu qui inclut des exemples de code. Markdown fournit plusieurs façons de formater le code, du simple code en ligne aux blocs de code complets avec coloration syntaxique.

Code en ligne

Pour de courts extraits de code dans les phrases, utilisez des backticks simples :

Utilisez la commande `git status` pour vérifier votre dépôt.
La fonction `console.log()` affiche dans la console.
Appuyez sur `Ctrl+C` pour arrêter le processus.

Résultat :

Utilisez la commande git status pour vérifier votre dépôt. La fonction console.log() affiche dans la console. Appuyez sur Ctrl+C pour arrêter le processus.

Blocs de code délimités

Pour le code multi-lignes, utilisez des triples backticks :

```
function greet(name) {
  console.log("Hello, " + name + "!");
}

greet("World");
```

Résultat :

function greet(name) {
  console.log("Hello, " + name + "!");
}

greet("World");

Coloration syntaxique

Ajoutez le nom du langage après les backticks d'ouverture pour la coloration syntaxique :

JavaScript

```javascript
function calculateSum(a, b) {
  return a + b;
}

const result = calculateSum(5, 3);
console.log(result); // Sortie : 8
```

Python

```python
def calculate_sum(a, b):
    return a + b

result = calculate_sum(5, 3)
print(result)  # Sortie : 8
```

Identifiants de langages populaires

Langage	Identifiant	Alternative
JavaScript	javascript	js
Python	python	py
Java	java
C++	cpp	c++
C#	csharp	cs
HTML	html
CSS	css
SQL	sql
JSON	json
XML	xml
Shell	bash	sh
TypeScript	typescript	ts
React JSX	jsx
PHP	php
Go	go
Rust	rust
Swift	swift

Notes importantes

Les blocs de code délimités sont la méthode préférée pour formater le code en Markdown car ils fournissent une meilleure coloration syntaxique et sont plus largement supportés sur différentes plateformes.

Meilleures pratiques

1. Toujours utiliser la coloration syntaxique

❌ Pas de coloration syntaxique :

```
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

✅ Avec coloration syntaxique :

```javascript
if (user.isLoggedIn) {
  showDashboard();
} else {
  showLoginForm();
}
```

2. Garder les exemples de code focalisés

❌ Trop de code non pertinent :

```javascript
// Beaucoup de code de configuration...
const express = require('express');
const app = express();
const PORT = 3000;

// ... plus de configuration ...

// L'exemple réel (noyé dans la configuration)
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});

// ... plus de code standard ...
```

✅ Focalisé sur la partie importante :

```javascript
// Créer un endpoint API simple
app.get('/api/users', (req, res) => {
  res.json({ users: [] });
});
```

Cas d'usage courants

Documentation API

Requête :

POST /api/users
Content-Type: application/json

{
  "name": "John Doe",
  "email": "[email protected]"
}

Réponse :

{
  "id": 123,
  "name": "John Doe",
  "email": "[email protected]",
  "created_at": "2024-01-15T10:30:00Z"
}

Fichiers de configuration

Créez un fichier .env dans la racine de votre projet :

# Configuration de base de données
DB_HOST=localhost
DB_PORT=5432
DB_NAME=monapp
DB_USER=postgres
DB_PASSWORD=motdepasse123

# Clés API
API_KEY=votre_cle_api_ici
SECRET_KEY=votre_cle_secrete_ici

Dépannage

Problèmes courants

1. Code qui ne se formate pas : Vérifiez les backticks appropriés
2. Coloration syntaxique qui ne fonctionne pas : Vérifiez l'identifiant de langage
3. Code qui casse la mise en page : Utilisez des sauts de ligne appropriés

Échapper les backticks

Si vous devez montrer des backticks dans votre code :

Exemple de backtick simple :

• •
  Écrire : `code`
• •
  Résultat : code

Exemple de triples backticks :

• •
  Écrire : ```bloc de code```
• •
  Résultat : bloc de code

Backticks dans le code en ligne :

• •
  Écrire : ``backtick``
• •
  Résultat : backtick

Les blocs de code sont essentiels pour la documentation technique. Utilisez-les pour rendre vos exemples de code clairs, lisibles et bien formatés !

Enfin, apprenons les sauts de ligne pour perfectionner votre formatage de texte.