Installation

Installation du package pypi

Pour installer MkDocs DSFR, exécutez la commande suivante :

pip install mkdocs-dsfr

Pour plus de détails, consultez la documentation Getting Started with MkDocs .

Configuration

Variables obligatoires du thème :

Nom	Exemple de valeur	Description
name	dsfr	Nom du thème (variable MkDocs)
logo_title	Intitulé Officiel	Titre du logo (header et footer)
header.service_title	MkDocs DSFR / Documentation	Titre principal dans le header
header.service_tagline	Documentation du projet MkDocs DSFR	Description sous le titre principal

Voici un exemple de configuration pour MkDocs DSFR dans le fichier mkdocs.yml :

---
# Project information
site_name: Your Site Name
site_url: https://example.com/
site_description: Site description
site_dir: public

# Repository
repo_name: Your Repo Name
repo_url: https://github.com/group-name/your-project

# Theme
theme:
  name: dsfr
  logo_title: Intitulé<br>Officiel
  header:
    service_title: MkDocs DSFR / Documentation
    service_tagline: Documentation du projet MkDocs DSFR

# Plugins
plugins:
  - search
  - dsfr-plugin

# Markdown extensions
markdown_extensions:
  - attr_list
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg