From dcd16461cbec180c2cde77685c9b28461b9a3ff5 Mon Sep 17 00:00:00 2001 From: HiDeoo <494699+HiDeoo@users.noreply.github.com> Date: Sat, 6 Jul 2024 11:45:07 +0200 Subject: [PATCH] i18n(fr): update `reference/configuration` (#2098) --- .../docs/fr/reference/configuration.mdx | 69 ++++++++++++------- 1 file changed, 45 insertions(+), 24 deletions(-) diff --git a/docs/src/content/docs/fr/reference/configuration.mdx b/docs/src/content/docs/fr/reference/configuration.mdx index 38d6c9a23c..d14660f8c8 100644 --- a/docs/src/content/docs/fr/reference/configuration.mdx +++ b/docs/src/content/docs/fr/reference/configuration.mdx @@ -100,25 +100,33 @@ Avec cette configuration, une page `/introduction` aurait un lien d'édition poi Configure les éléments de navigation de la barre latérale de votre site. Une barre latérale est un tableau de liens et de groupes de liens. -Chaque élément doit comporter un `label` et l'une des propriétés suivantes : +À l'exception des éléments utilisant `slug`, chaque élément doit comporter un `label` et l'une des propriétés suivantes : - `link` — un lien uninque vers une URL spécifique, comme `'/home'` ou `'https://example.com'`. +- `slug` — une référence à une page interne, par exemple `'guides/getting-started'`. + - `items` — un tableau contenant plus de liens et des sous-groupes. - `autogenerate` — un objet indiquant un répertoire de vos docs depuis lequel générer automatiquement un groupe de liens. +Les liens internes peuvent également être spécifiés sous forme de chaîne de caractères au lieu d'un objet avec une propriété `slug`. + ```js starlight({ sidebar: [ // Un lien unique étiqueté “Accueil”. { label: 'Accueil', link: '/' }, - // Un groupe étiqueté “Débuter ici” contenant deux liens. + // Un groupe étiqueté “Débuter ici” contenant quatre liens. { label: 'Débuter ici', items: [ - { label: 'Introduction', link: '/intro' }, - { label: 'Prochaines étapes', link: '/next-steps' }, + // Utilisation de `slug` pour les liens internes. + { slug: 'intro' }, + { slug: 'installation' }, + // Ou la forme simplifiée pour les liens internes. + 'tutorial', + 'next-steps', ], }, // Un groupe liant toutes les pages présentes dans le répertoire reference. @@ -141,16 +149,13 @@ Les groupes de liens sont développés par défaut. Vous pouvez modifier ce comp Les sous-groupes générés automatiquement respectent la propriété `collapsed` de leur groupe parent par défaut. Définissez la propriété `autogenerate.collapsed` pour remplacer ce comportement. -```js {5,16} +```js {5,13} sidebar: [ // Un groupe rétractable de liens. { label: 'Collapsed Links', collapsed: true, - items: [ - { label: 'Introduction', link: '/intro' }, - { label: 'Next Steps', link: '/next-steps' }, - ], + items: ['intro', 'next-steps'], }, // Un groupe développé contenant des sous-groupes générés automatiquement rétractés. { @@ -192,21 +197,37 @@ sidebar: [ #### `SidebarItem` ```ts -type SidebarItem = { - label: string; - translations?: Record; - badge?: string | BadgeConfig; -} & ( - | { - link: string; - attrs?: Record; - } - | { items: SidebarItem[]; collapsed?: boolean } - | { - autogenerate: { directory: string; collapsed?: boolean }; - collapsed?: boolean; - } -); +type SidebarItem = + | string + | ({ + translations?: Record; + badge?: string | BadgeConfig; + } & ( + | { + // Lien + link: string; + label: string; + attrs?: Record; + } + | { + // Lien interne + slug: string; + label?: string; + attrs?: Record; + } + | { + // Groupe de liens + label: string; + items: SidebarItem[]; + collapsed?: boolean; + } + | { + // Groupe de liens généré automatiquement + label: string; + autogenerate: { directory: string; collapsed?: boolean }; + collapsed?: boolean; + } + )); ``` #### `BadgeConfig`