Aller au contenu

Aide Technique MkDocs & Material

Page de référence pour la rédaction de documents avec MkDocs Material.

Admonitions — Encadrés

Note

Une information complémentaire

Les admonitions permettent de mettre en valeur du contenu important.

!!! note "Une information complémentaire"
    Les admonitions permettent de mettre en valeur du contenu important.

Conseil

Un conseil pratique

Pensez à sauvegarder votre travail régulièrement.

!!! tip "Un conseil pratique"
    Pensez à sauvegarder votre travail régulièrement.

Avertissement

Attention

Cette action est irréversible.

!!! warning "Attention"
    Cette action est irréversible.

Danger

Ne pas faire

Ne jamais modifier ce fichier directement en production.

!!! danger "Ne pas faire"
    Ne jamais modifier ce fichier directement en production.

Info

Information contextuelle

Cette fonctionnalité est disponible depuis la version 9.0.

!!! info "Information contextuelle"
    Cette fonctionnalité est disponible depuis la version 9.0.

Succès

Opération réussie

Le déploiement s'est terminé sans erreur.

!!! success "Opération réussie"
    Le déploiement s'est terminé sans erreur.

Exemple

Exemple concret

Voici comment se présente un exemple dans la page.

!!! example "Exemple concret"
    Voici comment se présente un exemple dans la page.

Citation

Citation

« La simplicité est la sophistication suprême. »

!!! quote "Citation"
    « La simplicité est la sophistication suprême. »

Sans titre

Une admonition sans titre visible.

!!! tip ""
    Une admonition sans titre visible.

Details — Blocs dépliables

Cliquez pour dérouler

Ce contenu est caché par défaut et s'affiche au clic.

??? note "Cliquez pour dérouler"
    Ce contenu est caché par défaut et s'affiche au clic.
Ouvert par défaut

Ce contenu est visible par défaut mais peut être replié.

???+ tip "Ouvert par défaut"
    Ce contenu est visible par défaut mais peut être replié.

Onglets dans le contenu

Contenu de la première option.

Contenu de la deuxième option.

Contenu de la troisième option.

=== "Première option"
    Contenu de la première option.

=== "Deuxième option"
    Contenu de la deuxième option.

=== "Troisième option"
    Contenu de la troisième option.

Tableaux

Colonne A Colonne B Colonne C
Valeur 1 Valeur 2 Valeur 3
Valeur 4 Valeur 5 Valeur 6 
| Colonne A | Colonne B | Colonne C |
|-----------|-----------|-----------|
| Valeur 1  | Valeur 2  | Valeur 3  |
| Valeur 4  | Valeur 5  | Valeur 6  |

Alignement

Gauche Centre Droite
texte texte texte
texte texte texte 
| Gauche | Centre | Droite |
|:-------|:------:|-------:|
| texte  | texte  | texte  |
| texte  | texte  | texte  |

Notes de bas de page

La Terre tourne autour du Soleil.1 Ce fait est établi depuis longtemps.2

La Terre tourne autour du Soleil.[^1] Ce fait est établi depuis longtemps.[^2]

[^1]: En 365 jours environ.
[^2]: Galilée en fit la démonstration au XVIIe siècle.

Mise en forme

Surligné

Le mot important est surligné.

Le mot ==important== est surligné.

Barré

Nécessite l'extension pymdownx.tilde dans mkdocs.yml.

Ce texte est barré.

~~Ce texte est barré.~~

Exposant et indice

Nécessite les extensions pymdownx.caret (exposant) et pymdownx.tilde (indice) dans mkdocs.yml.

L'eau est H2O. La surface est de 102 m².

L'eau est H~2~O. La surface est de 10^2^ m².

Touches clavier

Nécessite l'extension pymdownx.keys dans mkdocs.yml.

Appuyez sur Ctrl+S pour sauvegarder.

Appuyez sur ++ctrl+s++ pour sauvegarder.

Emojis

Terminé — Annulé — En cours

:material-check: Terminé — :material-close: Annulé — :material-clock: En cours

Abréviations automatiques

Nécessite l'extension abbr dans mkdocs.yml. Les abréviations définies en bas de page sont soulignées automatiquement dans tout le document avec une infobulle au survol.

Survolez les mots HTML et CSS dans cette phrase pour voir les infobulles.

Survolez les mots HTML et CSS dans cette phrase pour voir les infobulles.

*[HTML]: HyperText Markup Language
*[CSS]: Cascading Style Sheets

Blocs de code

Avec coloration syntaxique

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

print(bonjour("monde"))

    ```python
    def bonjour(nom):
        return f"Bonjour, {nom} !"

    print(bonjour("monde"))
    ```

Avec titre de fichier

config.yml
nom: exemple
version: 1.0
actif: true

    ``` yaml title="config.yml"
    nom: exemple
    version: 1.0
    actif: true
    ```

Avec numéros de ligne

1
2
3
Première ligne
Deuxième ligne
Troisième ligne

    ``` linenums="1"
    Première ligne
    Deuxième ligne
    Troisième ligne
    ```

Avec lignes surlignées

Ligne normale
Ligne surlignée
Ligne surlignée
Ligne normale

    ``` hl_lines="2 3"
    Ligne normale
    Ligne surlignée
    Ligne surlignée
    Ligne normale
    ```

Liens

Lien externe avec infobulle

Site officiel MkDocs

[Site officiel MkDocs](https://www.mkdocs.org "Documentation officielle")

Lien interne

[Voir la page d'accueil](../index.md)

Ancre dans la page

MkDocs génère automatiquement une ancre pour chaque titre. Le titre ## Tableaux devient #tableaux.

[Aller aux tableaux](#tableaux)

Images

![Texte alternatif](chemin/vers/image.png)

![Image avec taille](chemin/vers/image.png){ width=300 }

![Image alignée à droite](chemin/vers/image.png){ align=right }

Page de référence — MkDocs Material

  1. En 365 jours environ. ↩

  2. Galilée en fit la démonstration au XVIIe siècle. ↩