Skip to content

Commit

Permalink
Merge branch 'main' into updates-6
Browse files Browse the repository at this point in the history
  • Loading branch information
HiDeoo committed May 2, 2024
2 parents 0198a81 + dff9da6 commit c4609b1
Show file tree
Hide file tree
Showing 12 changed files with 158 additions and 11 deletions.
14 changes: 13 additions & 1 deletion docs/src/content/docs/es/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,22 @@ Puedes pasar las siguientes opciones a la integración `starlight`.

### `title` (requerido)

**tipo:** `string`
**tipo:** `string | Record<string, string>`

Establece el título de tu sitio web. Se utilizará en los metadatos y en el título de la pestaña del navegador.

El valor puede ser un string o para sitios multilingües, un objeto con valores para cada idioma diferente.
Cuando se usa la forma de objeto, las claves deben ser etiquetas BCP-47 (por ejemplo, `en`, `ar` o `zh-CN`):

```ts
starlight({
title: {
es: 'Mi encantador sitio de documentación',
de: 'Meine bezaubernde Dokumentationsseite',
},
});
```

### `description`

**tipo:** `string`
Expand Down
15 changes: 15 additions & 0 deletions docs/src/content/docs/es/reference/frontmatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,21 @@ pagefind: false
---
```

### `draft`

**tipo:** `boolean`
**por defecto:** `false`

Establece si esta página debe considerarse como un borrador y no incluirse en las [compilaciones de producción](https://docs.astro.build/es/reference/cli-reference/#astro-build) y [grupos de enlaces autogenerados](/es/guides/sidebar/#grupos-autogenerados). Establece en `true` para marcar una página como borrador y hacerla visible solo durante el desarrollo.

```md
---
# src/content/docs/example.md
# Excluye esta página de las compilaciones de producción
draft: true
---
```

### `sidebar`

**tipo:** [`SidebarConfig`](#sidebarconfig)
Expand Down
7 changes: 7 additions & 0 deletions docs/src/content/docs/es/resources/community-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -128,5 +128,12 @@ import YouTubeGrid from '~/components/youtube-grid.astro';
description:
'Pon en marcha un nuevo sitio de Starlight en unos 5 minutos',
},
{
href: 'https://www.youtube.com/watch?v=12o7WxjAxjM',
title:
'Incluye la documentación de Starlight en un proyecto de Next.js con proxies',
description:
'Configura Starlight como un proyecto de subdirectorio dentro de un sitio web de Next.js',
},
]}
/>
6 changes: 3 additions & 3 deletions docs/src/content/docs/fr/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Consultez les [instructions d'installation manuelle](/fr/manual-setup/) pour ajo

Créez un nouveau projet Astro + Starlight en lançant la commande suivante dans votre terminal :

<Tabs>
<Tabs syncKey="pkg">
<TabItem label="npm">

```sh
Expand Down Expand Up @@ -52,7 +52,7 @@ Lorsque vous travaillez localement, [le serveur de développement d'Astro](https

À l'intérieur du répertoire de votre projet, exécutez la commande suivante pour démarrer le serveur de développement :

<Tabs>
<Tabs syncKey="pkg">
<TabItem label="npm">

```sh
Expand Down Expand Up @@ -103,7 +103,7 @@ Assurez-vous de mettre à jour Starlight régulièrement !

Starlight est une intégration Astro. Vous pouvez la mettre à jour ainsi que tous autres packages Astro en exécutant la commande suivante dans votre terminal :

<Tabs>
<Tabs syncKey="pkg">
<TabItem label="npm">

```sh
Expand Down
45 changes: 45 additions & 0 deletions docs/src/content/docs/fr/guides/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,51 @@ Le code ci-dessus génère les onglets suivants sur la page :
</TabItem>
</Tabs>

#### Onglets synchronisés

Conservez plusieurs groupes d'onglets synchronisés en ajoutant l'attribut `syncKey`.

Tous les composants `<Tabs>` sur une page avec la même valeur `syncKey` afficheront le même label actif.
Cela permet à votre lecteur de choisir une fois (par exemple, leur système d'exploitation ou leur gestionnaire de paquets) et de voir leur choix reflété sur l'ensemble de la page.

Pour synchroniser des onglets liés, ajoutez une propriété `syncKey` identique à chaque composant `<Tabs>` et assurez-vous qu'ils utilisent tous les mêmes libellés de `<TabItem>` :

```mdx 'syncKey="constellations"'
# src/content/docs/exemple.mdx

import { Tabs, TabItem } from '@astrojs/starlight/components';

_Quelques étoiles :_

<Tabs syncKey="constellations">
<TabItem label="Orion">Bellatrix, Rigel, Bételgeuse</TabItem>
<TabItem label="Gémeaux">Pollux, Castor A, Castor B</TabItem>
</Tabs>

_Quelques exoplanètes :_

<Tabs syncKey="constellations">
<TabItem label="Orion">HD 34445 b, Gliese 179 b, Wasp-82 b</TabItem>
<TabItem label="Gémeaux">Pollux b, HAT-P-24b, HD 50554 b</TabItem>
</Tabs>
```

Le code ci-dessus génère les onglets suivants sur la page :

_Quelques étoiles :_

<Tabs syncKey="constellations">
<TabItem label="Orion">Bellatrix, Rigel, Bételgeuse</TabItem>
<TabItem label="Gémeaux">Pollux, Castor A, Castor B</TabItem>
</Tabs>

_Quelques exoplanètes :_

<Tabs syncKey="constellations">
<TabItem label="Orion">HD 34445 b, Gliese 179 b, Wasp-82 b</TabItem>
<TabItem label="Gémeaux">Pollux b, HAT-P-24b, HD 50554 b</TabItem>
</Tabs>

### Cartes

import { Card, CardGrid } from '@astrojs/starlight/components';
Expand Down
6 changes: 3 additions & 3 deletions docs/src/content/docs/fr/guides/css-and-tailwind.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Le module d'extension Tailwind de Starlight applique la configuration suivante :

Démarrez un nouveau projet Starlight avec Tailwind CSS préconfiguré en utilisant `create astro` :

<Tabs>
<Tabs syncKey="pkg">
<TabItem label="npm">

```sh
Expand Down Expand Up @@ -95,7 +95,7 @@ Si vous avez déjà un site Starlight et que vous souhaitez ajouter Tailwind CSS

1. Ajoutez l'intégration Astro pour Tailwind :

<Tabs>
<Tabs syncKey="pkg">

<TabItem label="npm">

Expand Down Expand Up @@ -125,7 +125,7 @@ Si vous avez déjà un site Starlight et que vous souhaitez ajouter Tailwind CSS

2. Installez le module d'extension Tailwind de Starlight :

<Tabs>
<Tabs syncKey="pkg">

<TabItem label="npm">

Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/fr/guides/customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Vous pouvez personnaliser - ou même désactiver - la table des matières global

Par défaut, les titres `<h2>` et `<h3>` sont inclus dans la table des matières. Modifiez les niveaux de titres à inclure à l’échelle du site à l’aide des options `minHeadingLevel` et `maxHeadingLevel` dans votre option de configuration [globale `tableOfContents`](/fr/reference/configuration/#tableofcontents). Remplacez ces valeurs par défaut sur une page individuelle en ajoutant les propriétés [frontmatter `tableOfContents`](/fr/reference/frontmatter/#tableofcontents) correspondantes :

<Tabs>
<Tabs syncKey="config-type">
<TabItem label="Frontmatter">

```md {4-6}
Expand Down Expand Up @@ -164,7 +164,7 @@ defineConfig({

Désactivez la table des matières complètement en définissant l’option `tableOfContents` à `false`:

<Tabs>
<Tabs syncKey="config-type">
<TabItem label="Frontmatter">

```md {4}
Expand Down
28 changes: 28 additions & 0 deletions docs/src/content/docs/fr/guides/i18n.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,34 @@ Starlight s'attend à ce que vous créiez des pages équivalentes dans toutes vo
Si une traduction n'est pas encore disponible pour une langue, Starlight affichera aux lecteurs le contenu de cette page dans la langue par défaut (définie via `defaultLocale`). Par exemple, si vous n'avez pas encore créé de version française de votre page À propos et que votre langue par défaut est l'anglais, les visiteurs de `/fr/about` verront le contenu anglais de `/en/about` avec un avis indiquant que cette page n'a pas encore été traduite. Cela vous permet d'ajouter du contenu dans votre langue par défaut et de le traduire progressivement lorsque vos traducteurs en ont le temps.

## Traduire le titre du site

Par défaut, Starlight utilisera le même titre de site pour toutes les langues.
Si vous avez besoin de personnaliser le titre pour chaque langue, vous pouvez passer un objet à [`title`](/fr/reference/configuration/#title-obligatoire) dans les options de Starlight :

```diff lang="js"
// astro.config.mjs
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
export default defineConfig({
integrations: [
starlight({
- title: 'Ma documentation',
+ title: {
+ fr: 'Ma documentation',
+ 'zh-CN': '我的文档',
+ },
defaultLocale: 'fr',
locales: {
fr: { label: 'Français' },
'zh-cn': { label: '简体中文', lang: 'zh-CN' },
},
}),
],
});
```

## Traduire l'interface utilisateur de Starlight
import LanguagesList from '~/components/languages-list.astro';
Expand Down
1 change: 1 addition & 0 deletions docs/src/content/docs/fr/guides/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ Les propriétés suivantes diffèrent du frontmatter en Markdown :
- La propriété [`slug`](/fr/reference/frontmatter/#slug) n'est pas supportée et est automatiquement définie en fonction de l'URL de la page personnalisée.
- L'option [`editUrl`](/fr/reference/frontmatter/#editurl) nécessite une URL pour afficher un lien d'édition.
- La propriété [`sidebar`](/fr/reference/frontmatter/#sidebar) du frontmatter permettant de personnaliser l'affichage de la page dans les [groupes de liens autogénérés](/fr/reference/configuration/#sidebar) n'est pas disponible. Les pages utilisant le composant `<StarlightPage />` ne font pas partie d'une collection et ne peuvent pas être ajoutées à un groupe de liens autogénérés.
- L'option [`draft`](/fr/reference/frontmatter/#draft) affiche uniquement une [note](/fr/reference/overrides/#draftcontentnotice) indiquant que la page est une ébauche, mais ne l'exclut pas automatiquement des déploiements en production.

##### `sidebar`

Expand Down
14 changes: 13 additions & 1 deletion docs/src/content/docs/fr/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,22 @@ Vous pouvez passer les options suivantes à l'intégration `starlight`.

### `title` (obligatoire)

**Type :** `string`
**Type :** `string | Record<string, string>`

Définissez le titre de votre site web. Il sera utilisé dans les métadonnées et dans le titre de l'onglet du navigateur.

La valeur peut être une chaîne de caractères, ou pour les sites multilingues, un objet avec des valeurs pour chacune des différentes locales.
Lorsque vous utilisez la forme objet, les clés doivent être des étiquettes d'identification BCP-47 (par exemple `fr`, `ar`, ou `zh-CN`) :

```ts
starlight({
title: {
fr: 'Mon délicieux site de docs',
de: 'Meine bezaubernde Dokumentationsseite',
},
});
```

### `description`

**Type :** `string`
Expand Down
15 changes: 15 additions & 0 deletions docs/src/content/docs/fr/reference/frontmatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,21 @@ pagefind: false
---
```

### `draft`

**Type :** `boolean`
**Par défaut :** `false`

Définit si cette page doit être considérée comme une ébauche et ne pas être incluse dans les [déploiements en production](https://docs.astro.build/fr/reference/cli-reference/#astro-build) et les [groupes de liens générés automatiquement](/fr/guides/sidebar/#groupes-générés-automatiquement). Définissez la valeur à `true` pour marquer une page comme une ébauche et la rendre visible uniquement pendant le développement.

```md
---
# src/content/docs/exemple.md
# Exclure cette page des déploiements en production
draft: true
---
```

### `sidebar`

**Type :** [`SidebarConfig`](#sidebarconfig)
Expand Down
14 changes: 13 additions & 1 deletion docs/src/content/docs/fr/reference/overrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ L’étiquette d’identification BCP-47 pour la langue de la page, par exemple

Le chemin de base utilisé pour servir une langue. `undefined` pour les slugs de la locale racine.

#### `siteTitle`

**Type :** `string`

Le titre du site pour la langue de cette page.

#### `slug`

**Type :** `string`
Expand Down Expand Up @@ -218,7 +224,7 @@ Ces composants affichent la barre de navigation supérieure de Starlight.
**Composant par défaut :** [`Header.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/Header.astro)

Composant d'en-tête affiché en haut de chaque page.
L'implémentation par défaut affiche [`<SiteTitle />`](#sitetitle), [`<Search />`](#search), [`<SocialIcons />`](#socialicons), [`<ThemeSelect />`](#themeselect) et [`<LanguageSelect />`](#languageselect).
L'implémentation par défaut affiche [`<SiteTitle />`](#sitetitle-1), [`<Search />`](#search), [`<SocialIcons />`](#socialicons), [`<ThemeSelect />`](#themeselect) et [`<LanguageSelect />`](#languageselect).

#### `SiteTitle`

Expand Down Expand Up @@ -332,6 +338,12 @@ Composant contenant l'élement `<h1>` de la page courante.

Les implémentations personnalisées doivent s'assurer qu'elles définissent `id="_top"` sur l'élément `<h1>` comme dans l'implémentation par défaut.

#### `DraftContentNotice`

**Composant par défaut :** [`DraftContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/DraftContentNotice.astro)

Note affichée aux utilisateurs durant le développement lorsque la page actuelle est marquée comme une ébauche.

#### `FallbackContentNotice`

**Composant par défaut :** [`FallbackContentNotice.astro`](https://github.com/withastro/starlight/blob/main/packages/starlight/components/FallbackContentNotice.astro)
Expand Down

0 comments on commit c4609b1

Please sign in to comment.