Aller au contenu principal

📝 Fichier Markdown

Les fichiers Markdown (.md) permettent d’écrire du texte structurĂ©, lisible Ă  la fois par les humains et les machines. Ils sont souvent utilisĂ©s pour la documentation, les notes, ou les fichiers README.


CrĂ©er un fichier Markdown dans PyCharm​

  1. Ouvrir un projet dans PyCharm (ou en créer un nouveau).
  2. Dans l’arborescence Ă  gauche, cliquer-droit sur le dossier oĂč crĂ©er le fichier.
  3. Choisir New > File.
  4. Nommer le fichier avec l’extension .md, par exemple notes.md, puis appuyer sur ⏎.
  5. Un nouvel onglet s’ouvre avec un Ă©diteur Markdown.

PrĂ©visualiser le fichier Markdown​

  1. Dans la barre d’outils du haut, cliquer sur l’icîne de Editor and Preview (des lignes et un rectangle) dans la barre d’outils en haut.
  2. PyCharm affiche Ă  gauche le texte brut (code source), et Ă  droite le rendu visuel.

Écrire du contenu Markdown​

  1. Taper du texte dans le fichier (Ă  gauche) en utilisant la syntaxe Markdown.
  2. Ajouter des titres, des listes, des liens, des images ou des blocs de code (voir exemples ci-dessous).
  3. Le rendu visuel Ă  droite se met Ă  jour automatiquement.

Exemple de contenu Markdown :​

# Mes notes

Voici une **liste de tĂąches** :

- Lire la documentation
- Écrire un `README.md`
- Apprendre Markdown

## Exemple de lien

[Documentation Markdown](https://www.markdownguide.org)

## Exemple de code

```python
def dire_bonjour(nom):
print(f"Bonjour, {nom}!")
```

RĂ©sultat affichĂ© :​

.

Mes notes

Voici une liste de tĂąches :

  • Lire la documentation
  • Écrire un README.md
  • Apprendre Markdown

Exemple de lien​

Documentation Markdown

Exemple de code​

def dire_bonjour(nom):
print(f"Bonjour, {nom}!")

Astuces​

  • Utiliser README.md dans un projet GitHub permet d'afficher automatiquement la description du projet sur la page principale.
  • Pour insĂ©rer des images locales, utiliser la syntaxe ![texte alternatif](chemin/vers/image.png).