Démonstration avancée¶
Cette page présente les fonctionnalités avancées de MkDocs Material.
Diagrammes Mermaid¶
Flowchart¶
graph LR
A[📝 Écrire] --> B{Relire ?}
B -->|Oui| C[✏️ Corriger]
B -->|Non| D[🚀 Publier]
C --> B
D --> E[🎉 En ligne !] Diagramme de séquence¶
sequenceDiagram
participant U as Utilisateur
participant S as Serveur
participant DB as Base de données
U->>S: Requête HTTP
S->>DB: Query SQL
DB-->>S: Résultats
S-->>U: Réponse JSON Diagramme de Gantt¶
gantt
title Planning du projet
dateFormat YYYY-MM-DD
section Phase 1
Recherche :a1, 2025-01-01, 30d
Conception :a2, after a1, 20d
section Phase 2
Développement :a3, after a2, 40d
Tests :a4, after a3, 15d
section Phase 3
Déploiement :a5, after a4, 10d Diagramme circulaire¶
pie title Répartition du temps
"Développement" : 40
"Réunions" : 20
"Documentation" : 15
"Tests" : 25 Boutons¶
Bouton simple Bouton primaire Lien GitHub
Icônes Material¶
| Icône | Code |
|---|---|
:material-account: | |
:material-heart: | |
:material-star: | |
:material-check-circle: | |
:material-alert: | |
:material-book-open-variant: | |
:material-cog: | |
:material-download: | |
:fontawesome-brands-github: | |
:fontawesome-brands-python: | |
:fontawesome-brands-docker: |
Touches clavier¶
| Action | Raccourci |
|---|---|
| Copier | Ctrl+C |
| Coller | Ctrl+V |
| Annuler | Ctrl+Z |
| Sauvegarder | Ctrl+S |
| Rechercher | Ctrl+F |
| Terminal VS Code | Ctrl+` |
| Palette commandes | Ctrl+Shift+P |
Annotations dans le code¶
def fibonacci(n): # (1)!
"""Calcule le n-ième nombre de Fibonacci."""
if n <= 1: # (2)!
return n
return fibonacci(n-1) + fibonacci(n-2) # (3)!
resultat = fibonacci(10)
print(f"Résultat : {resultat}") # (4)!
- Définition de la fonction avec un paramètre
n - Cas de base de la récursion
- Appel récursif — attention à la complexité !
- Affichage formaté avec f-string
Abréviations (survole avec la souris)¶
Le HTML et le CSS sont essentiels pour le développement web. Python est un langage interprété, souvent utilisé avec des API REST.
Critiques (révisions de texte)¶
Voici un exemple de texte supprimé et de texte ajouté.
On peut aussi remplacermodifier du texte.
Le texte peut être surligné pour attirer l'attention.
Ceci est un commentaire qui apparaît au survol.Formules mathématiques¶
En ligne¶
La formule d'Einstein est \(E = mc^2\) et la formule quadratique est \(x = \frac{-b \pm \sqrt{b^2-4ac}}{2a}\).
En bloc¶
L'intégrale de Gauss :
La série de Taylor :
Grilles de cartes¶
-
Installation rapide
Installez MkDocs Material en quelques minutes avec pip
-
Sécurisé par défaut
HTTPS, headers de sécurité, rate limiting intégrés
-
Personnalisable
Thèmes clair/sombre, couleurs, polices personnalisables
-
Open Source
MIT License — libre d'utilisation et de modification
Liste de définitions¶
MkDocs- Un générateur de site statique pour la documentation, écrit en Python.
Material- Un thème pour MkDocs basé sur Material Design de Google.
Markdown- Un langage de balisage léger pour formater du texte.
Contenu tabulé avancé¶
Images avec légende¶
Timeline (avec admonitions)¶
2025 - Lancement
Création du site Cap Biblique avec MkDocs Material.
Aujourd'hui - En ligne
Le site est accessible à tous sur https://capbiblique.fr
Futur - Évolutions
Ajout de nouvelles fonctionnalités et contenus.
Émojis populaires¶
| Catégorie | Émojis |
|---|---|
| Visages | |
| Mains | |
| Symboles | |
| Objets | |
| Nature |