Markdown pour les développeurs Python

Les traitements de texte comme Microsoft Word ou LibreOffice ne sont pas adaptés à l’écriture technique contenant du code Python. Pour vos notes de cours, vos documentations de projet, vos README ou vos tutoriels, il est préférable d’utiliser un format tel que Markdown.

Markdown est un langage de balisage léger créé en 2004 par John Gruber avec l’aide d’Aaron Swartz. Aujourd’hui, c’est le standard de facto sur GitHub, GitLab, Jupyter, ReadTheDocs, MkDocs et presque tous les outils collaboratifs modernes.

Les éléments essentiels de Markdown

Titres

Placez un ou plusieurs # au début de la ligne :

# Titre niveau 1
## Titre niveau 2
### Titre niveau 3

Listes

Listes à puces :

- élément
* élément
+ élément

Listes numérotées (la numérotation est corrigée automatiquement) :

1. Premier
5. Deuxième (Markdown affichera 2.)
10. Troisième

Liens et images

[Python.org](https://www.python.org/)
![Logo Python](https://www.python.org/static/img/python-logo.png)

Emphase

**gras** ou __gras__
*italique* ou _italique_
***gras et italique***

Citations

> Une citation en bloc
>> > Citation imbriquée

Blocs de code (très important en Python !)

Utilisez trois accents graves (backticks) suivi du mot-clé python pour une coloration syntaxique parfaite :

```python
def saluer(nom: str) -> str:
    """Retourne un message de bienvenue."""
    return f"Bonjour {nom} ! Bienvenue en Python 🐍"

print(saluer("Alice"))
```

Ce qui donne :

def saluer(nom: str) -> str:
    """Retourne un message de bienvenue."""
    return f"Bonjour {nom} ! Bienvenue en Python 🐍"

print(saluer("Alice"))

Conversion Markdown → PDF ou site web

Si vous utilisez Visual Studio Code, vous pouvez convertir un fichier MarkDown (avec l'extension md) en PDF grâce à l'extension Markdown PDF.

Laboratoire MarkDown

Si vous utilisez Visual Studio Code, vous pouvez déjà utiliser MarkDown en créant un fichier avec l'extension md. Pour vous familiariser avec la syntaxe MarkDown, nous vous invitons à mettre à l'essai le laboratoire suivant.

# Liste d'Étudiants

Voici une liste d'étudiants inscrits :

- **Jean Aaron**
- **Pierre Laroche**

*Fin du document.*