Glossaire

Markdown ✍️

Markdown est un langage de balisage léger créé par John Gruber en 2004. Il permet d’écrire du texte facilement lisible tout en pouvant être converti en HTML ou d'autres formats structurés.

Il est utilisé dans :

  • Les README sur GitHub/GitLab
  • Les générateurs de sites statiques (Jekyll, Hugo…)
  • Les systèmes de documentation (MkDocs, Docusaurus…)
  • Les blocs-notes Jupyter

🧱 Syntaxes de base

Titres

## Titre 1
### Titre 2
#### Titre 3
...

Texte en gras, italique, barré

**gras**  
*italique*  
~~barré~~

Rendu : gras, italique, ~~barré~~

Listes

- Liste à puces
  - Sous-niveau

Rendu : - Liste à puces - Sous-niveau

  1. Liste ordonnée
  2. Deuxième item

Liens et images

[OpenAI](https://openai.com)

![Texte alternatif](https://via.placeholder.com/100)

Code

  • code en ligne

  • Bloc de code :



def hello():
    print("Bonjour Markdown !")

Citations

> Ceci est une citation.

Rendu :

Ceci est une citation.

Tableaux

| Colonne A | Colonne B |
|-----------|-----------|
| Valeur 1  | Valeur 2  |
Colonne A Colonne B
Valeur 1 Valeur 2

📦 Avantages

  • Facile à lire même brut
  • Large support sur le web
  • Compatible avec les systèmes de contrôle de version (Git)

🔧 Extensions courantes (via GitHub Flavored Markdown)

  • Tâches :
    ```markdown
  • [x] Terminé

  • [ ] À faire ```

  • Blocs mathématiques (via KaTeX/MathJax dans certains outils)

  • Diagrammes (via Mermaid)

📚 Ressources

📓 Jupyter Notebooks

Les Jupyter Notebooks sont des documents interactifs mêlant texte riche, code exécutable et résultats visuels (graphiques, tableaux…).

Très utilisés en data science, en enseignement, en recherche et pour la documentation technique.

🚀 Fonctionnalités principales

  • Écriture de code interactif (Python, Julia, R…)
  • Affichage de graphiques (matplotlib, seaborn…)
  • Intégration de formules mathématiques (via LaTeX)
  • Ajout de texte en Markdown
  • Export possible vers HTML, PDF, LaTeX…

🧱 Structure d’un Notebook

Un notebook .ipynb est composé de cellules :

  • 📄 Cellules Markdown : pour le texte, les titres, les images
  • 💻 Cellules de code : pour écrire et exécuter du code
  • 📊 Sorties : résultats du code (texte, images, tableaux…)

▶️ Exemple de cellules

Cellule Markdown

### Ma première analyse
Voici une moyenne simple :
$\bar{x} = \frac{1}{n} \sum_{i=1}^n x_i$

Cellule de code

data = [1, 2, 3, 4]
sum(data) / len(data)

⚙️ Lancer un notebook

  1. Installer Jupyter via pip :
pip install notebook
  1. Démarrer Jupyter :
jupyter notebook
  1. Le navigateur s’ouvre automatiquement :
  2. Choisir/créer un fichier .ipynb
  3. Commencer à coder !

💡 Bonnes pratiques

  • Ajouter des titres et explications en Markdown
  • Utiliser les blocs if __name__ == "__main__": dans les scripts importés
  • Nettoyer les sorties avant de partager (Kernel > Restart & Clear Output)

📦 Extensions utiles

  • JupyterLab : interface moderne
  • nbextensions : plugin de fonctionnalités avancées
  • Voila : pour transformer un notebook en application web

🌍 Utilisation en ligne

📚 Ressources

🌐 Jekyll

Jekyll est un générateur de site statique écrit en Ruby. Il transforme des fichiers Markdown, HTML ou Liquid en sites web rapides, maintenables et déployables sur GitHub Pages.

🚀 Pourquoi utiliser Jekyll ?

  • Génère des sites statiques à partir de Markdown
  • Intégration native avec GitHub Pages
  • Facile à versionner avec Git
  • Supporte les layouts, includes et plugins
  • Idéal pour blogs, documentations, portfolios