summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHiDeoo2025-07-17 10:00:39 +0200
committerGitHub2025-07-17 10:00:39 +0200
commit24123e26eadf846fe89d63a693ce0ecf2657aee4 (patch)
tree44dbf0fc874af41064bbb54d9243e5755020cd21
parent4e4808dddeec6d850e99db2268bad0b62c2a681d (diff)
downloadIT.starlight-24123e26eadf846fe89d63a693ce0ecf2657aee4.tar.gz
IT.starlight-24123e26eadf846fe89d63a693ce0ecf2657aee4.tar.bz2
IT.starlight-24123e26eadf846fe89d63a693ce0ecf2657aee4.zip
i81n(fr): `manual-setup.mdx` and `reference/configuration.mdx` (#3316)
Co-authored-by: Armand Philippot <git@armand.philippot.eu>
-rw-r--r--docs/src/content/docs/fr/manual-setup.mdx2
-rw-r--r--docs/src/content/docs/fr/reference/configuration.mdx122
2 files changed, 122 insertions, 2 deletions
diff --git a/docs/src/content/docs/fr/manual-setup.mdx b/docs/src/content/docs/fr/manual-setup.mdx
index c55268e0..ce82ef48 100644
--- a/docs/src/content/docs/fr/manual-setup.mdx
+++ b/docs/src/content/docs/fr/manual-setup.mdx
@@ -64,7 +64,7 @@ Retrouvez toutes les options disponibles dans la [référence de configuration S
Starlight s'appuie sur les [collections de contenu d'Astro](https://docs.astro.build/fr/guides/content-collections/), qui sont configurées dans le fichier `src/content.config.ts`.
-Créez ou mettez à jour le fichier de configuration du contenu, en ajoutant une collection `docs` qui utilise les `docsLoader` et `docsSchema` de Starlight :
+Créez ou mettez à jour le fichier de configuration du contenu, en ajoutant une collection `docs` qui utilise [`docsLoader`](/fr/reference/configuration/#docsloader) et [`docsSchema`](/fr/reference/configuration/#docsschema) de Starlight :
```js ins={3-4,7}
// src/content.config.ts
diff --git a/docs/src/content/docs/fr/reference/configuration.mdx b/docs/src/content/docs/fr/reference/configuration.mdx
index 6fa7d764..a66ed672 100644
--- a/docs/src/content/docs/fr/reference/configuration.mdx
+++ b/docs/src/content/docs/fr/reference/configuration.mdx
@@ -224,7 +224,11 @@ type SidebarItem =
| {
// Groupe de liens généré automatiquement
label: string;
- autogenerate: { directory: string; collapsed?: boolean };
+ autogenerate: {
+ directory: string;
+ collapsed?: boolean;
+ attrs?: Record<string, string | number | boolean | undefined>;
+ };
collapsed?: boolean;
}
));
@@ -673,3 +677,119 @@ starlight({
credits: true,
});
```
+
+## Configuration des collections de contenu
+
+Starlight utilise les [collections de contenu d'Astro](https://docs.astro.build/fr/guides/content-collections/) pour charger votre contenu.
+Les chargeurs (également connus sous le nom de « loaders » en anglais) et schémas de collection de Starlight aident à configurer les collections comme nécessaire.
+
+```js
+// src/content.config.ts
+import { defineCollection } from 'astro:content';
+import { docsLoader, i18nLoader } from '@astrojs/starlight/loaders';
+import { docsSchema, i18nSchema } from '@astrojs/starlight/schema';
+
+export const collections = {
+ docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
+ // Optionel : la collection i18n est utilisée pour traduire l'interface
+ // utilisateur dans les sites multilingues
+ i18n: defineCollection({ loader: i18nLoader(), schema: i18nSchema() }),
+};
+```
+
+### Chargeurs
+
+Starlight exporte les [chargeurs Astro](https://docs.astro.build/fr/reference/content-loader-reference/) suivants depuis le module `@astrojs/starlight/loaders` pour simplifier la configuration des collections de contenu.
+
+#### `docsLoader()`
+
+Le chargeur `docsLoader()` charge les fichiers Markdown, MDX et Markdoc locaux du répertoire `src/content/docs/`.
+Les fichiers commençant par un tiret bas (`_`) sont ignorés.
+
+##### Importation
+
+```js
+import { docsLoader } from '@astrojs/starlight/loaders';
+```
+
+##### Options
+
+###### `generateId()`
+
+**Type :** `({ entry: string; base: URL; data: Record<string, unknown> }) => string`
+
+Par défaut, les pages générées en utilisant `docsLoader()` transforment les noms de fichiers en utilisant un générateur de slug qui supprime les caractÚres spéciaux et met le nom de fichier en minuscules.
+Si vous souhaitez remplacer ce comportement par défaut, spécifiez votre propre fonction `generateId()`.
+
+Par exemple, cela peut ĂȘtre utile pour prĂ©server des caractĂšres spĂ©ciaux qui seraient supprimĂ©s.
+Par défaut, `Exemple.Fichier.md` serait diponible à l'URL `/exemplefichier`.
+Si vous souhaitez le rendre disponible à l'URL `/Exemple.Fichier`, vous pouvez le faire en définissant une fonction `generateId()` personnalisée :
+
+```js
+docsLoader({
+ // Supprime les extension `.md` ou `.mdx` sans modifier les noms de fichiers.
+ generateId: ({ entry }) => entry.split('.').slice(0, -1).join('.'),
+}),
+```
+
+Consultez [`generateId()` dans la documentation d'Astro](https://docs.astro.build/fr/reference/content-loader-reference/#generateid) pour plus de détails.
+
+#### `i18nLoader()`
+
+Le chargeur `i18nLoader()` charge les fichiers JSON et YAML locaux du répertoire `src/content/i18n/`.
+Les fichiers commençant par un tiret bas (`_`) sont ignorés.
+
+##### Importation
+
+```js
+import { i18nLoader } from '@astrojs/starlight/loaders';
+```
+
+##### Options
+
+Il n'y a pour le moment aucune option pour configurer `i18nLoader()`.
+
+### Schémas
+
+Starlight fournit les [schémas de collection de contenu](https://docs.astro.build/fr/guides/content-collections/#d%C3%A9finition-dun-sch%C3%A9ma-de-collection) suivants depuis le module `@astrojs/starlight/schema`.
+Ces schĂ©mas doivent ĂȘtre utilisĂ©s pour les collections `docs` et `i18n` dont Starlight dĂ©pend.
+
+#### `docsSchema()`
+
+Le chargeur `docsSchema()` analyse (opération également appelée « parse » en anglais) le frontmatter de tout le contenu de la collection `docs`.
+
+##### Importation
+
+```js
+import { docsSchema } from '@astrojs/starlight/schema';
+```
+
+##### Options
+
+###### `extend`
+
+**Type :** Schéma Zod ou fonction qui retourne un schéma Zod
+**Par défaut :** `z.object({})`
+
+Étendez le schĂ©ma du frontmatter de Starlight avec des champs supplĂ©mentaires.
+Consultez [« Personnaliser le schéma du frontmatter »](/fr/reference/frontmatter/#personnaliser-le-schéma-du-frontmatter) pour plus de détails sur l'utilisation de l'option `extend`.
+
+#### `i18nSchema()`
+
+Le chargeur `i18nSchema()` analyse tous les fichiers de données dans la collection `i18n`.
+
+##### Importation
+
+```js
+import { i18nSchema } from '@astrojs/starlight/schema';
+```
+
+##### Options
+
+###### `extend`
+
+**Type :** Objet Zod
+**Par défaut :** `z.object({})`
+
+Étendez le schĂ©ma de traduction de Starlight avec des champs supplĂ©mentaires.
+Consultez [« Étendre le schĂ©ma de traduction »](/fr/guides/i18n/#Ă©tendre-le-schĂ©ma-de-traduction) pour plus de dĂ©tails sur l'utilisation de l'option `extend`.