Welcome to MkDocs¶

Information importante

Le contenu de l'admonition supporte tout le Markdown :
listes, code, liens, etc.

Astuce

Utilisez mkdocs serve --dirty pour accélérer le rechargement
sur les gros projets (seules les pages modifiées sont regénérées).

Attention

Ne commitez jamais de secrets dans votre documentation.

Danger

Supprimer le dossier site/ en production efface la documentation
déployée.

Cliquez pour voir l'exemple

Contenu masqué par défaut. Utile pour les longues sorties
de commandes ou les configurations complètes.

Astuce (ouverte par défaut)

L'utilisateur peut replier cet encadré s'il le souhaite.

Rappel

Cet encadré flotte à droite du paragraphe suivant.

Avec l'option content.tabs.link activée dans les features du thème, un clic
sur un onglet synchronise tous les onglets de la page qui portent le même
label.

Blocs de code avancés¶

Material ajoute des fonctionnalités puissantes aux blocs de code standard :

Titre, numéros de lignes et bouton copier :

def saluer(nom: str) -> str:
    """Retourne un message de bienvenue."""
    return f"Bonjour {nom} !"

print(saluer("DevOps"))

Annotations dans le code (nécessite content.code.annotate dans les
features) :

theme:
  name: material # (1)!
  features:
    - navigation.instant # (2)!

Le thème Material est le plus populaire pour MkDocs
Active la navigation sans rechargement de page

graph LR
    A[Écrire en Markdown] --> B[mkdocs build]
    B --> C[Site HTML statique]
    C --> D{Déployer}
    D --> E[GitHub Pages]
    D --> F[GitLab Pages]
    D --> G[Serveur interne]