Aller au contenu

Guide de Formatage

Cette page démontre les différentes options de formatage disponibles dans Material for MkDocs.

Formatage de Texte

Vous pouvez utiliser différentes options de formatage de texte :

  • Texte en gras avec **gras**
  • Texte en italique avec *italique*
  • Texte barré avec ~~texte~~
  • Texte surligné avec ==texte==
  • H2O indice avec H~2~O
  • X2 exposant avec X^2^
  • ++Souligné++ avec ++texte++

Touches de Clavier

Utiliser des raccourcis clavier :

  • Ctrl+C pour copier
  • Ctrl+V pour coller
  • Cmd+Shift+P pour la palette de commandes

Code

Code en ligne : pip install mkdocs-material

Bloc de code avec numéros de ligne :

1
2
3
4
5
6
7
8
9
def fibonacci(n):
    """Calculer le nombre de Fibonacci."""
    if n <= 1:
        return n
    return fibonacci(n-1) + fibonacci(n-2)

# Calculer le 10ème nombre de Fibonacci
resultat = fibonacci(10)
print(f"Fibonacci(10) = {resultat}")

Code avec lignes spécifiques surlignées :

def saluer(nom):
    message = f"Bonjour, {nom}!"
    print(message)
    return message

Onglets

print("Bonjour le Monde!")
console.log("Bonjour le Monde!");
echo "Bonjour le Monde!"

Avertissements

Note

Ceci est un avertissement de note.

Abstract

Ceci est un avertissement abstrait.

Info

Ceci est un avertissement d'information.

Tip

Ceci est un avertissement d'astuce.

Success

Ceci est un avertissement de succès.

Question

Ceci est un avertissement de question.

Warning

Ceci est un avertissement d'alerte.

Failure

Ceci est un avertissement d'échec.

Danger

Ceci est un avertissement de danger.

Bug

Ceci est un avertissement de bug.

Example

Ceci est un avertissement d'exemple.

Quote

Ceci est un avertissement de citation.

Avertissement Pliable

Cet avertissement est pliable !

Listes

Listes Non Ordonnées

  • Élément 1
  • Élément 2
  • Élément imbriqué 2.1
  • Élément imbriqué 2.2
  • Élément 3

Listes Ordonnées

  1. Premier élément
  2. Deuxième élément
  3. Troisième élément
  4. Élément imbriqué 3.1
  5. Élément imbriqué 3.2

Listes de Tâches

  • Tâche terminée
  • Autre tâche terminée
  • Tâche incomplète
  • Autre tâche incomplète

Diagrammes avec Mermaid

graph LR
    A[Début] --> B{Ça fonctionne?}
    B -->|Oui| C[Super!]
    B -->|Non| D[Déboguer]
    D --> B
    C --> E[Fin]

Boutons

Commencer Voir sur GitHub

Notes de Bas de Page

Voici une phrase avec une note de bas de page1.


  1. Ceci est le contenu de la note de bas de page.