diff options
author | Paul Valladares | 2023-07-27 14:44:54 -0600 |
---|---|---|
committer | GitHub | 2023-07-27 22:44:54 +0200 |
commit | 8e1072a427b04e7331a79ba59d7fdefcf0810b1e (patch) | |
tree | 70e8173d971eeb13b0cd4e1a2e6e4c64b9b10e8a | |
parent | c7b2a4e9c8c55564be75f0c0901e38577ac764ec (diff) | |
download | IT.starlight-8e1072a427b04e7331a79ba59d7fdefcf0810b1e.tar.gz IT.starlight-8e1072a427b04e7331a79ba59d7fdefcf0810b1e.tar.bz2 IT.starlight-8e1072a427b04e7331a79ba59d7fdefcf0810b1e.zip |
i18n(fr): Update authoring-content.mdx & add manual-setup.md (#411)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
-rw-r--r-- | docs/src/content/docs/fr/guides/authoring-content.md | 2 | ||||
-rw-r--r-- | docs/src/content/docs/fr/manual-setup.mdx | 129 |
2 files changed, 130 insertions, 1 deletions
diff --git a/docs/src/content/docs/fr/guides/authoring-content.md b/docs/src/content/docs/fr/guides/authoring-content.md index 3ebc034e..0757290e 100644 --- a/docs/src/content/docs/fr/guides/authoring-content.md +++ b/docs/src/content/docs/fr/guides/authoring-content.md @@ -29,7 +29,7 @@ Vous pouvez mettre en évidence le `code en ligne` à l'aide de barres de défil ## Images -Les images dans Starlight utilisent la prise en charge intégrée des ressources optimisées d'Astro. +Les images dans Starlight utilisent [la prise en charge intégrée des ressources optimisées d'Astro](https://docs.astro.build/en/guides/assets/). Markdown et MDX supportent la syntaxe Markdown pour l'affichage des images qui inclut le texte alt pour les lecteurs d'écran et les technologies d'assistance. diff --git a/docs/src/content/docs/fr/manual-setup.mdx b/docs/src/content/docs/fr/manual-setup.mdx new file mode 100644 index 00000000..9f931845 --- /dev/null +++ b/docs/src/content/docs/fr/manual-setup.mdx @@ -0,0 +1,129 @@ +--- +title: Installation manuelle +description: Apprendre à configurer Starlight manuellement pour l'ajouter à un projet Astro existant. +--- + +import { Tabs, TabItem } from '@astrojs/starlight/components'; + +La façon la plus rapide de créer un nouveau site Starlight est d'utiliser `create astro` comme indiqué dans le [guide de démarrage](/fr/getting-started/#creating-a-new-project). +Si vous voulez ajouter Starlight à un projet Astro existant, ce guide vous expliquera comment faire. + +## Configurer Starlight + +Pour suivre ce guide, vous aurez besoin d'un projet Astro existant. + +### Ajouter l'intégration Starlight + +Starlight est une [intégration Astro](https://docs.astro.build/fr/guides/integrations-guide/). Ajoutez-la à votre site en exécutant la commande `astro add` dans le répertoire racine de votre projet : + +<Tabs> + <TabItem label="npm"> + ```sh + npx astro add starlight + ``` + + </TabItem> + <TabItem label="pnpm"> + ```sh + pnpm astro add starlight + ``` + </TabItem> + <TabItem label="Yarn"> + ```sh + yarn astro add starlight + ``` + </TabItem> + +</Tabs> + +Cela installera les dépendances requises et ajoutera Starlight au tableau `integrations` dans votre fichier des configuration Astro. + +### Configurer l'intégration + +L'intégration Starlight est configurée dans votre fichier `astro.config.mjs`. + +Ajoutez un titre avec la propriété `title` pour commencer : + +```js {7-9} +// astro.config.mjs +import { defineConfig } from 'astro/config'; +import starlight from '@astrojs/starlight'; + +export default defineConfig({ + integrations: [ + starlight({ + title: 'Mon ravissant site de documentation' + }), + ], +}); +``` + +Retrouvez toutes les options disponibles dans la [référence de configuration Starlight](/fr/reference/configuration/). + +### Configurer les collections de contenu + +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 le schéma `docsSchema` de Starlight : + + +```js ins={3,6} +// src/content/config.ts +import { defineCollection } from 'astro:content'; +import { docsSchema } from '@astrojs/starlight/schema'; + +export const collections = { + docs: defineCollection({ schema: docsSchema() }), +}; +``` + +### Ajouter du contenu + +Starlight est maintenant configuré et il est temps d'ajouter du contenu ! + +Créez un repetoire `src/content/docs/` et commencez par ajouter un fichier `index.md`. +Ce sera la page d'accueil de votre nouveau site : + +```md +--- +# src/content/docs/index.md +title: Ma documentation +description: En savoir plus sur mon projet dans ce site de documentation construit avec Starlight. +--- + +Bienvenue dans mon projet ! +``` + +Starlight utilise une stratégie de routage basée sur les fichiers, ce qui signifie que chaque fichier Markdown, MDX ou Markdoc dans `src/content/docs/` deviendra une page de votre site. Les métadonnées du frontmatter (les champs `title` et `description` dans l'exemple ci-dessus) peuvent modifier la façon dont chaque page est affichée. +Retrouvez toutes les options disponibles dans la [référence du frontmatter](/fr/reference/frontmatter/). + +## Astuce pour les sites existants + +Si vous avez un projet d'Astro existant, vous pouvez utiliser Starlight pour ajouter rapidement une section de documentation à votre site. + +### Utiliser Starlight dans un sous-chemin + +Pour ajouter toutes les pages Starlight dans un sous-chemin, placez tout votre contenu de documentation dans un sous-répertoire de `src/content/docs/`. + +Par exemple, si les pages de Starlight doivent toutes commencer par `/guides/`, ajoutez votre contenu dans le répertoire `src/content/docs/guides/` : + +import FileTree from '../../../components/file-tree.astro'; + +<FileTree> + +- src/ + - content/ + - docs/ + - **guides/** + - guide.md + - index.md + - pages/ +- astro.config.mjs + +</FileTree> + +À l'avenir, nous prévoyons de mieux supporter ce cas d'utilisation pour éviter le besoin du répertoire supplémentaire dans `src/content/docs/`. + +### Utiliser Starlight avec SSR + +À l'heure actuelle, Starlight ne supporte pas [le déploiement avec rendu côté serveur (SSR)](https://docs.astro.build/fr/guides/server-side-rendering/) en utilisant les adaptateurs de serveur d'Astro. Nous espérons pouvoir le supporter bientôt. |