Pages et frontmatter

Chaque page de documentation est un fichier .mdx situé dans le répertoire apps/docs/src/content/docs/.

Chemin du contenu

Les fichiers suivent cette structure :

apps/docs/src/content/docs/{project}/{version}/{locale}/{path}.mdx

Par exemple :

apps/docs/src/content/docs/explainer/default/en/getting-started.mdx

project — Nom du répertoire de premier niveau (ex. explainer)
version — default pour non versionné, ou un nom de version comme v1, v2
locale — Code de langue (ex. en, fr)
path — Chemin du fichier qui devient les segments de l’URL

Modèle d’URL

L’URL générée suit ce modèle :

/{locale}/{project}/{path}

La version default est omise de l’URL. Les documentations versionnées incluent la version :

Chemin du fichier	URL
`explainer/default/en/getting-started.mdx`	`/en/explainer/getting-started`
`explainer/default/en/guides/installation.mdx`	`/en/explainer/guides/installation`
`my-lib/v2/en/migration.mdx`	`/en/my-lib/v2/migration`

Schéma du frontmatter

Chaque fichier MDX commence par un bloc frontmatter YAML :

example-page.mdx
---
title: My Page Title
description: A brief description of this page.
icon: book-open
order: 2
permalink: /custom-url
---

Page content starts here...

Champs disponibles

Champ	Type	Requis	Description
`title`	`string`	Oui	Titre de la page affiché dans la barre latérale, le fil d’Ariane et la balise `<title>`
`description`	`string`	Non	Courte description pour les balises méta SEO et les miniatures OG
`icon`	`string`	Non	Identifiant d’icône (depuis Iconify) affiché à côté du titre dans la barre latérale
`order`	`number`	Non	Contrôle la position dans la barre latérale. Les nombres inférieurs apparaissent en premier
`permalink`	`string`	Non	Remplace l’URL générée automatiquement par un chemin personnalisé

Si order n’est pas spécifié, les pages sont triées alphabétiquement par nom de fichier.