Structure du projet

Ce guide vous montre comment est organisé un projet Statidocs et à quoi servent les différents fichiers de votre projet.

Les projets Statidocs suivent la même structure de fichiers et de répertoires que les projets Cecil. Consultez la documentation de Cecil sur l’organisation des fichiers pour plus de détails.

Exemple

<my-project>
├─ assets/
│  ├─ favicon.png
│  └─ logo.png
├─ data/
│  └─ authors.yml
├─ layouts/
├─ pages/
│  ├─ docs/
│  │  ├─ index.md
│  │  ├─ Introduction/
│  │  │  ├─ index.md
│  │  │  └─ 11-Getting started.md
│  │  └─ Guides/
│  │     ├─ index.md
│  │     └─ 21-Project structure.md
│  ├─ about.md
│  └─ index.md
├─ static/
├─ themes/
│  └─ docs/
├─ translations/
│  └─ messages.fr.yaml
├─ cecil.yml
└─ composer.json

Fichiers et répertoires

cecil.yml — Le fichier de configuration.
composer.json — Les dépendances du projet : thèmes Cecil (Docs, PWA, etc.).
pages/ — Le contenu de votre site, rédigé en Markdown :
- pages/index.md — La page d’accueil, construite à partir de blocs définis dans son front matter.
- pages/docs/ — Chaque fichier Markdown (.md) de ce répertoire est transformé en page de documentation ; chaque sous-répertoire contenant un fichier index.md devient un groupe de la barre latérale.
assets/ — Les ressources (styles, images, favicon, PDF, etc.) qui seront traitées (redimensionnées, optimisées, empreintées, etc.).
static/ (facultatif) — Les fichiers copiés tels quels dans le site généré.
data/ (facultatif) — Les fichiers de données (YAML, JSON, CSV, etc.) disponibles dans les templates, comme la liste des auteurs.
layouts/ (facultatif) — Vos propres templates Twig, pour surcharger ceux du thème.
themes/ — Les thèmes installés, gérés par Composer : ne les modifiez pas directement.
translations/ (facultatif) — Les données de traduction nécessaires à l’internationalisation.