Démonstration MkDocs Material¶

Cette page présente les fonctionnalités de MkDocs Material.

Admonitions (encadrés)¶

Note

Ceci est une note. Utile pour des informations complémentaires.

Astuce

Une astuce pour gagner du temps.

Attention

Un avertissement à ne pas ignorer.

Danger

Quelque chose de critique !

Information

Une information générale.

Question

Une question à méditer.

Citation

« La simplicité est la sophistication suprême. » — Léonard de Vinci

Admonitions dépliables¶

Clique pour ouvrir

Ce contenu est caché par défaut.

Tu peux mettre plusieurs paragraphes.

Ouvert par défaut

Le + fait que c'est ouvert au chargement de la page.

Onglets¶

Python

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

    bonjour("Jérôme")

JavaScript

    function bonjour(nom) {
        console.log(`Bonjour ${nom} !`);
    }

    bonjour("Jérôme");

Bash

    echo "Bonjour Jérôme !"

Blocs de code¶

Code simple¶

print("Hello World")

Avec titre et numéros de ligne¶

mon_script.py
def calculer_somme(a, b):
    """Calcule la somme de deux nombres."""
    return a + b

resultat = calculer_somme(5, 3)
print(resultat)

Avec lignes surlignées¶

mkdocs.yml

site_name: Mon Site
theme:
  name: material
plugins:
  - search

Tableaux¶

Fonctionnalité	Description	Difficulté
Admonitions	Encadrés colorés	Facile
Onglets	Contenu tabulé	Facile
Blocs de code	Coloration syntaxique	Facile
Diagrammes	Mermaid, etc.	Moyen

Mise en forme du texte¶

Texte en gras
Texte en italique
~~Texte barré~~
Texte surligné
Code inline
Lien vers Google
Lien interne vers À propos

Listes¶

Liste simple¶

Premier élément
Deuxième élément
- Sous-élément A
- Sous-élément B
Troisième élément

Liste numérotée¶

Première étape
Deuxième étape
Troisième étape

Liste de tâches¶

[x] Installer MkDocs
[x] Configurer le thème Material
[ ] Écrire le contenu
[ ] Publier le site

Notes de bas de page¶

Voici une phrase avec une note¹.

Et une autre avec une référence plus longue².

Émojis¶

Séparateur¶

Texte avant le séparateur.

Texte après le séparateur.

Ceci est la première note de bas de page. ↩
Ceci est une note plus détaillée qui peut contenir plusieurs lignes. ↩