Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

i18n(fr): Update guides/components and getting-started #1506

Merged
merged 22 commits into from
Feb 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
a32f1b5
i18n(fr): Update `guides/components`
thomasbnt Feb 17, 2024
86a83c0
i18n(fr): Update `getting-started`
thomasbnt Feb 17, 2024
c23202d
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
95a1980
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
4ba7431
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
3509d8e
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
8b17d8c
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
fad8b6c
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
e5d9f81
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
ad7703c
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
e0e741a
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
c121891
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 17, 2024
3deb76f
forgot a sentence L88
thomasbnt Feb 17, 2024
6d3f323
Merge branch 'main' into i18n-fr-update-getting-started-and-components
thomasbnt Feb 17, 2024
650354b
edit authoring-content for "Asides" -> "Encarts"
thomasbnt Feb 17, 2024
c372c79
fix link #asides -> #encarts in components L235
thomasbnt Feb 17, 2024
16311c5
Update docs/src/content/docs/fr/getting-started.mdx
thomasbnt Feb 18, 2024
d634854
Update docs/src/content/docs/fr/guides/components.mdx
thomasbnt Feb 18, 2024
637eafa
Update docs/src/content/docs/fr/guides/authoring-content.md
thomasbnt Feb 18, 2024
a1a88e5
Update docs/src/content/docs/fr/guides/authoring-content.md
thomasbnt Feb 18, 2024
1df954a
Update docs/src/content/docs/fr/guides/authoring-content.md
thomasbnt Feb 18, 2024
56c7961
Merge branch 'main' into i18n-fr-update-getting-started-and-components
thomasbnt Feb 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 7 additions & 42 deletions docs/src/content/docs/fr/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,50 +83,16 @@ Ouvrez cette URL pour commencer à naviguer sur votre site.

Starlight est prêt pour que vous puissiez ajouter du nouveau contenu, ou apporter vos fichiers existants !

#### Formats de fichiers
Ajoutez de nouvelles pages à votre site en créant des fichiers Markdown dans le répertoire `src/content/docs/`.

Starlight prend en charge la création de contenu en Markdown et MDX sans aucune configuration requise.
Vous pouvez ajouter la prise en charge de Markdoc en installant [l'intégration Astro Markdoc](https://docs.astro.build/fr/guides/integrations-guide/markdoc/) expérimentale.

#### Ajouter des pages

Ajoutez de nouvelles pages à votre site en créant des fichiers `.md` ou `.mdx` dans `src/content/docs/`.
Utilisez des sous-dossiers pour organiser vos fichiers et créer plusieurs segments de chemin.

Par exemple, la structure de fichiers suivante génére des pages à `example.com/hello-world` et `example.com/guides/faq` :

import FileTree from '~/components/file-tree.astro';

<FileTree>

- src/
- content/
- docs/
- guides/
- faq.md
- hello-world.md

</FileTree>

#### Frontmatter avec sûreté du typage

Toutes les pages Starlight partagent un [ensemble commun de propriétés du frontmatter](/fr/reference/frontmatter/) personnalisable pour contrôler l'apparence de la page :

```md
---
title: Bonjour, le monde !
description: Ceci est une page de mon site web propulsé par Starlight.
---
```

Si vous oubliez quelque chose d'important, Starlight vous le fera savoir.
Pour en savoir plus sur le routage par fichier et la prise en charge des fichiers MDX et Markdoc, consultez le guide [« Pages »](/fr/guides/pages/).

### Prochaines étapes

- **Configurer:** Découvrez les options courantes dans [« Personnaliser Starlight »](/fr/guides/customization/).
- **Naviguer:** Configurez votre barre latérale avec le guide [« Barre latérale de navigation »](/fr/guides/sidebar/).
- **Composants:** Découvrez les cartes, les onglets et d'autres composants intégrés dans le guide [« Composants »](/fr/guides/components/).
- **Déployer:** Publiez votre travail avec le guide [« Déployer votre site »](https://docs.astro.build/fr/guides/deploy/) dans la documentation d'Astro.
- **Configurer :** Découvrez les options courantes dans [« Personnaliser Starlight »](/fr/guides/customization/).
- **Naviguer :** Configurez votre barre latérale avec le guide [« Barre latérale de navigation »](/fr/guides/sidebar/).
- **Composants :** Découvrez les cartes, les onglets et d'autres composants intégrés dans le guide [« Composants »](/fr/guides/components/).
- **Déployer :** Publiez votre travail avec le guide [« Déployer votre site »](https://docs.astro.build/fr/guides/deploy/) dans la documentation d'Astro.

## Mettre à jour Starlight

Expand All @@ -135,8 +101,7 @@ Comme Starlight est un logiciel en version bêta, il y aura des mises à jour et
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 :
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>
<TabItem label="npm">
Expand Down
16 changes: 8 additions & 8 deletions docs/src/content/docs/fr/guides/authoring-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,15 @@ Les titres de niveau 2 (`<h2>`) et de niveau 3 (`<h3>`) apparaissent automatique

Pour en apprendre davantage sur la façon dont Astro traite les attributs `id` des titres de section, consultez la [documentation d'Astro](https://docs.astro.build/fr/guides/markdown-content/#identifiants-den-t%C3%AAte).

## Asides
## Encarts

Les Asides (également connus sous le nom de "callouts") sont utiles pour afficher des informations secondaires à côté du contenu principal d'une page.
Les encarts (également connus sous le nom de « admonitions » ou « asides » en anglais) sont utiles pour afficher des informations secondaires à côté du contenu principal d'une page.

Starlight fournit une syntaxe Markdown personnalisée pour le rendu des apartés. Les blocs d'apartés sont indiqués en utilisant une paire de triples points `:::` pour envelopper votre contenu, et peuvent être de type `note`, `tip`, `caution` ou `danger`.
Starlight fournit une syntaxe Markdown personnalisée pour le rendu des encarts. Les blocs d'encarts sont indiqués en utilisant une paire de triples points `:::` pour envelopper votre contenu, et peuvent être de type `note`, `tip`, `caution` ou `danger`.

Vous pouvez imbriquer n'importe quel autre type de contenu Markdown à l'intérieur d'un aparté, mais les aparté sont mieux adaptés à des morceaux de contenu courts et concis.

### Note aside
### Encart de type note

:::note
Starlight est une boîte à outils pour sites web de documentation construite avec [Astro](https://astro.build/). Vous pouvez démarrer avec cette commande :
Expand All @@ -137,9 +137,9 @@ npm run create astro@latest --template starlight
:::
````

### Titres personnalisés dans les asides
### Titres personnalisés dans les encarts

Vous pouvez spécifier un titre personnalisé pour l'aparté entre crochets après le type d'aparté, par exemple `:::tip[Le saviez-vous ?]`.
Vous pouvez spécifier un titre personnalisé pour l'encart entre crochets après le type d'encarts, par exemple `:::tip[Le saviez-vous ?]`.

:::tip[Le saviez-vous ?]
Astro vous aide à construire des sites Web plus rapides grâce à ["Islands Architecture"](https://docs.astro.build/fr/concepts/islands/).
Expand All @@ -151,9 +151,9 @@ Astro vous aide à construire des sites Web plus rapides grâce à ["Islands Arc
:::
```

### Plus de types pour l'aside
### Plus de types d'encarts

Les apartés de type Attention et Danger sont utiles pour attirer l'attention de l'utilisateur sur des détails qui pourraient le perturber. Si vous vous retrouvez à utiliser ces derniers fréquemment, cela pourrait aussi être un signe que ce que vous documentez pourrait bénéficier d'une refonte.
Les encarts de type Attention et Danger sont utiles pour attirer l'attention de l'utilisateur sur des détails qui pourraient le perturber. Si vous vous retrouvez à utiliser ces derniers fréquemment, cela pourrait aussi être un signe que ce que vous documentez pourrait bénéficier d'une refonte.

:::caution
Si vous n'êtes pas sûr de vouloir un site de documentation génial, réfléchissez à deux fois avant d'utiliser [Starlight](/fr/).
Expand Down
57 changes: 56 additions & 1 deletion docs/src/content/docs/fr/guides/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -179,14 +179,69 @@ import { LinkCard } from '@astrojs/starlight/components';
<LinkCard title="Composants" href="/fr/guides/components/" />
</CardGrid>

### Encarts

Les encarts (également connus sous le nom de « admonitions » ou « asides » en anglais) sont utiles pour afficher des informations secondaires à côté du contenu principal d'une page.

Le composant `<Aside>` peut avoir un `type` optionnel de `note` (par défaut), `tip`, `caution` ou `danger`. La définition d'un attribut `title` remplace le titre par défaut de l'encart.

````mdx
# src/content/docs/exemple.mdx

import { Aside } from '@astrojs/starlight/components';

<Aside>Un encart par défaut sans titre personnalisé.</Aside>

<Aside type="caution" title="Prenez garde !">
Un encart d'avertissement *avec* un titre personnalisé.
</Aside>

<Aside type="tip">

D'autres contenus sont également pris en charge dans les encarts.

```js
// Un extrait de code, par exemple.
```

</Aside>

<Aside type="danger">Ne donnez votre mot de passe à personne.</Aside>
````

Le code ci-dessus génère ce qui suit sur la page :

import { Aside } from '@astrojs/starlight/components';

<Aside>Un encart par défaut sans titre personnalisé.</Aside>

<Aside type="caution" title="Prenez garde !">
Un encart d'avertissement *avec* un titre personnalisé.
</Aside>

<Aside type="tip">

D'autres contenus sont également pris en charge dans les encarts.

```js
// Un extrait de code, par exemple.
```

</Aside>

<Aside type="danger">Ne donnez votre mot de passe à personne.</Aside>

Starlight fournit également une syntaxe personnalisée pour afficher des encarts dans du contenu Markdown et MDX comme alternative au composant `<Aside>`.
Voir le guide de [« Création de contenu en Markdown »](/fr/guides/authoring-content/#encarts) pour plus de détails sur la syntaxe personnalisée.

### Icônes

import { Icon } from '@astrojs/starlight/components';
import IconsList from '~/components/icons-list.astro';

Starlight fournit un ensemble d'icônes courantes que vous pouvez afficher dans votre contenu à l'aide du composant `<Icon>`.

Chaque `<Icon>` nécessite un [`name`](#toutes-les-icônes) et peut optionellement inclure un attribut `label`, `size` et `color`.
Chaque `<Icon>` nécessite un [`name`](#toutes-les-icônes) et peut optionnellement inclure un attribut `label`, `size` et `color`.

```mdx
# src/content/docs/exemple.mdx
Expand Down
Loading