Skip to content

Commit

Permalink
Merge branch 'main' into hd-i18n-fr-pages-draft
Browse files Browse the repository at this point in the history
  • Loading branch information
HiDeoo committed May 2, 2024
2 parents d98b716 + 21f2966 commit 071ff7d
Show file tree
Hide file tree
Showing 27 changed files with 327 additions and 67 deletions.
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
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
6 changes: 3 additions & 3 deletions docs/src/content/docs/ko/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Starlight는 [Astro](https://astro.build) 프레임워크 위에 구축되었으

터미널에서 다음 명령을 실행하여 새 Astro + Starlight 프로젝트를 생성합니다.

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

```sh
Expand Down Expand Up @@ -54,7 +54,7 @@ yarn create astro --template starlight

프로젝트 디렉터리에서 다음 명령을 실행하여 개발 서버를 시작합니다.

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

```sh
Expand Down Expand Up @@ -105,7 +105,7 @@ Starlight는 베타 소프트웨어이기 때문에 업데이트와 개선이

Starlight는 Astro 통합입니다. 터미널에서 다음 명령을 실행하여 이 패키지와 다른 Astro 패키지를 업데이트할 수 있습니다.

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

```sh
Expand Down
44 changes: 44 additions & 0 deletions docs/src/content/docs/ko/guides/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,50 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
</TabItem>
</Tabs>

#### 동기화된 탭

`syncKey` 속성을 추가하여 여러 탭 그룹을 동기화된 상태로 유지합니다.

동일한 `syncKey` 값을 가진 페이지의 모든 `<Tabs>`에는 동일한 활성 라벨이 표시됩니다. 이를 통해 독자는 한 번 (예: 운영 체제 또는 패키지 관리자) 선택하고 선택 사항이 페이지 전체에 반영되는 것을 볼 수 있습니다.

관련 탭을 동기화하려면 각 `<Tabs>` 컴포넌트에 동일한 `syncKey` 속성을 추가하고 모두 동일한 `<TabItem>` 라벨을 사용하는지 확인하세요.

```mdx 'syncKey="별자리"'
# src/content/docs/example.mdx

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

_별:_

<Tabs syncKey="별자리">
<TabItem label="오리온자리">벨라트릭스, 리겔, 베텔게우스</TabItem>
<TabItem label="쌍둥이자리">폴룩스, 캐스터 A, 캐스터 B</TabItem>
</Tabs>

_외계 행성:_

<Tabs syncKey="별자리">
<TabItem label="오리온자리">HD 34445 b, 글리제 179 b, Wasp-82 b</TabItem>
<TabItem label="쌍둥이자리">폴룩스 b, HAT-P-24b, HD 50554 b</TabItem>
</Tabs>
```

위 코드는 페이지에 다음을 생성합니다.

_별:_

<Tabs syncKey="별자리">
<TabItem label="오리온자리">벨라트릭스, 리겔, 베텔게우스</TabItem>
<TabItem label="쌍둥이자리">폴룩스, 캐스터 A, 캐스터 B</TabItem>
</Tabs>

_외계 행성:_

<Tabs syncKey="별자리">
<TabItem label="오리온자리">HD 34445 b, 글리제 179 b, Wasp-82 b</TabItem>
<TabItem label="쌍둥이자리">폴룩스 b, HAT-P-24b, HD 50554 b</TabItem>
</Tabs>

### 카드

import { Card, CardGrid } from '@astrojs/starlight/components';
Expand Down
6 changes: 3 additions & 3 deletions docs/src/content/docs/ko/guides/css-and-tailwind.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Starlight Tailwind 플러그인은 다음 구성을 적용합니다.

`create astro`를 사용하여 Tailwind CSS가 사전 구성된 새 Starlight 프로젝트를 시작하세요.

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

```sh
Expand Down Expand Up @@ -94,7 +94,7 @@ yarn create astro --template starlight/tailwind

1. Astro의 Tailwind 통합 추가

<Tabs>
<Tabs syncKey="pkg">

<TabItem label="npm">

Expand Down Expand Up @@ -124,7 +124,7 @@ yarn create astro --template starlight/tailwind

2. Starlight Tailwind 플러그인을 설치하세요.

<Tabs>
<Tabs syncKey="pkg">

<TabItem label="npm">

Expand Down
4 changes: 2 additions & 2 deletions docs/src/content/docs/ko/guides/customization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Starlight는 독자가 원하는 제목으로 쉽게 이동할 수 있도록 각

기본적으로 `<h2>``<h3>` 제목이 목차에 포함됩니다. [`tableOfContents`](/ko/reference/configuration/#tableofcontents)`minHeadingLevel``maxHeadingLevel` 옵션을 사용하여 모든 페이지의 목차를 변경할 수 있습니다. 개별 페이지의 기본 목차를 변경하기 위해서는 [프론트매터에 `tableOfContents`](/ko/reference/frontmatter/#tableofcontents) 속성을 추가하세요.

<Tabs>
<Tabs syncKey="config-type">
<TabItem label="개별 페이지 설정">

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

`tableOfContents` 옵션의 값을 `false`로 설정하여 모든 페이지의 목차를 비활성화 할 수 있습니다.

<Tabs>
<Tabs syncKey="config-type">
<TabItem label="개별 페이지 설정">

```md {4}
Expand Down
28 changes: 28 additions & 0 deletions docs/src/content/docs/ko/guides/i18n.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,34 @@ Starlight는 귀하가 모든 언어로 같은 페이지를 생성할 것을 기

특정 언어에 대한 번역이 아직 제공되지 않는 경우 Starlight는 독자에게 해당 페이지의 콘텐츠를 기본 언어(`defaultLocale`을 통해 설정된 언어)로 표시합니다. 예를 들어, About 페이지의 프랑스어 버전을 아직 만들지 않았고 기본 언어가 영어인 경우 `/fr/about`에 방문한 독자는 이 페이지가 아직 번역되지 않았다는 알림과 함께 `/en/about`에 있는 영어 콘텐츠를 보게 됩니다. 이를 통해 기본 언어로 콘텐츠를 추가한 다음 점진적으로 번역할 수 있습니다.

## 사이트 제목 번역

기본적으로 Starlight는 모든 언어에 대해 동일한 사이트 제목을 사용합니다.
각 로케일의 제목을 사용자 정의해야 하는 경우 Starlight 옵션의 [`title`](/ko/reference/configuration/#title-필수)에 객체를 전달할 수 있습니다.

```diff lang="js"
// astro.config.mjs
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
export default defineConfig({
integrations: [
starlight({
- title: '나의 문서',
+ title: {
+ ko: '나의 문서',
+ 'zh-CN': '我的文档',
+ },
defaultLocale: 'ko',
locales: {
ko: { label: '한국어' },
'zh-cn': { label: '简体中文', lang: 'zh-CN' },
},
}),
],
});
```

## Starlight UI 번역

import LanguagesList from '~/components/languages-list.astro';
Expand Down
Loading

0 comments on commit 071ff7d

Please sign in to comment.