Plugins

Enrichir votre site avec la recherche, les cartes de partage, le blog, les tags et l'optimisation.

Configuration

Les plugins s'ajoutent dans properdocs.yml :

plugins:
  - search
  - social
  - tags
  - minify
  - git-revision-date-localized

search

Recherche full-text intégrée - activée par défaut.

plugins:
  - search:
      lang: fr

Features associées

search.suggest : autocomplétion dans la barre de recherche
search.highlight : surbrillance des termes trouvés dans la page

Génère automatiquement une image Open Graph (OG) pour chaque page - idéal pour le partage sur Twitter/LinkedIn.

plugins:
  - social:
      cards_layout_options:
        font_family: Noto Sans

Dépendances système

Le plugin social nécessite des librairies système (Cairo) :

sudo apt-get install -y libcairo2-dev libpango1.0-dev libgdk-pixbuf2.0-dev libffi-dev
pip install mkdocs-material[imaging]

blog

Système de blog complet avec auteurs, dates et catégories.

plugins:
  - blog:
      blog_dir: blog
      authors_file: "{blog}/.authors.yml"

Créez un fichier blog/.authors.yml :

authors:
  alex:
    name: Alex Lamizana
    description: Développeur & Étudiant 42
    avatar: https://github.com/Lamizana.png

Chaque post commence avec un frontmatter :

---
title: Mon article
date: 2026-01-15
authors:
  - alex
categories:
  - Python
tags:
  - tutorial
---

rss

Génère un flux RSS pour le blog.

plugins:
  - rss:
      match_path: blog/posts/.*
      date_from_meta:
        as_creation: date
      categories:
        - categories
        - tags

Le flux est disponible à /feed.xml.

minify

Minifie le HTML de sortie pour réduire la taille du site.

plugins:
  - minify:
      minify_html: true

git-revision-date-localized

Affiche la date de dernière modification de chaque page (basée sur git).

plugins:
  - git-revision-date-localized:
      type: date
      locale: fr
      enable_creation_date: true

CI requise

Nécessite fetch-depth: 0 dans le workflow GitHub Actions pour avoir l'historique git complet.

redirects

Rediriger d'anciennes URLs vers de nouvelles.

plugins:
  - redirects:
      redirect_maps:
        ancienne-page.md: nouvelle-page.md