Composants de documentation

Référence de tous les éléments disponibles pour écrire la documentation — chaque composant montre son rendu et le Markdown qui le produit.

Cette page est la référence visuelle de la documentation Cogni-Actif. Chaque bloc montre le rendu et le Markdown qui le produit.

Titres

H2 — Section principale

## Section principale

H3 — Sous-titre

### Sous-titre

H4 — Label technique

#### Label technique

Texte

Texte normal avec du gras, de l’italique, et du code inline.

Plusieurs paragraphes se séparent par une ligne vide.

Texte normal avec du **gras**, de l'*italique*, et du `code inline`.

Plusieurs paragraphes se séparent par une ligne vide.

Listes

Non ordonnée

• Premier élément
• Deuxième élément
  • Sous-élément imbriqué
• Troisième élément

- Premier élément
- Deuxième élément
  - Sous-élément imbriqué
- Troisième élément

Ordonnée

1. Première étape
2. Deuxième étape
3. Troisième étape

1. Première étape
2. Deuxième étape
3. Troisième étape

Callouts

[!NOTE] Information complémentaire non bloquante.

[!TIP] Conseil pratique ou raccourci utile.

[!WARNING] Point d’attention avant d’agir.

[!IMPORTANT] Règle critique à ne pas ignorer.

> [!NOTE]
> Information complémentaire non bloquante.

> [!TIP]
> Conseil pratique ou raccourci utile.

> [!WARNING]
> Point d'attention avant d'agir.

> [!IMPORTANT]
> Règle critique à ne pas ignorer.

Bloc de code

public class ChambreManager : AbstractSingleton<ChambreManager>
{
    [SerializeField] private GameObject chambrePrefab;

    public void ChargerChambre(string idEleve)
    {
        // Chargement de la chambre personnalisée
    }
}

```csharp
public class ChambreManager : AbstractSingleton<ChambreManager>
{
    [SerializeField] private GameObject chambrePrefab;

    public void ChargerChambre(string idEleve)
    {
        // Chargement de la chambre personnalisée
    }
}
```

Langages supportés : csharp, js, ts, json, bash, yaml, html, css, markdown.

Tableau

| Système | Fichier principal | Pattern |
|---------|-------------------|---------|
| Audio | `AudioManager.cs` | Singleton |
| Backend | `PlayFabManager.cs` | Singleton |
| Monnaie | `DBManager.cs` | Static |

[!TIP] Les tableaux larges défilent horizontalement sur mobile — pas besoin d’adapter la structure.

Image

![Description de l'image](/images/categorie/feature/nom.png)

[!TIP] Stocke les images dans public/images/[catégorie]/[feature]/. Toujours rédiger une description pour l’accessibilité (texte alt).

Convention de nommage : kebab-case, suffixe du contexte (-editeur, -ingame, -schema).

public/
└── images/
    ├── gameplay/
    │   └── apa/
    │       ├── qcm-ingame.png
    │       └── pendu-editeur.png
    └── personnages/
        └── avatar/
            └── chambre-editeur.png

Boutons de référence

Utilisés pour lier des pages compagnons (code, assets) sans alourdir la page principale.

<div class="ref-btn-group">
  <a href="/docs/v1-0/[slug]-code" class="ref-btn">→ Voir le code</a>
  <a href="/docs/v1-0/[slug]-assets" class="ref-btn ref-btn--assets">→ Voir les assets</a>
</div>

Le label est libre — → Voir le code, → Voir les assets, → Voir le diagramme, etc.

Convention de nommage des pages compagnons

Frontmatter d’une page compagnon

---
title: "Titre de la page compagnon"
category: "Même catégorie que le parent"
categoryOrder: 99
order: 99
version: "v1.0"
hidden: true        # ← exclut de la sidebar, conserve l'URL
---

[!NOTE] Les pages hidden: true n’apparaissent pas dans la navigation mais sont accessibles via leur URL directe — elles peuvent être partagées entre développeurs.

Séparateur

---