Aller au contenu
Starlight

Mise en route

Starlight est un thème de documentation complet construit sur la base du framework Astro. Ce guide vous aidera à démarrer un nouveau projet. Consultez les instructions d’installation manuelle pour ajouter Starlight à un projet Astro existant.

Démarrage rapide

Créer un nouveau projet

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

Fenêtre de terminal
npm create astro@latest -- --template starlight

Cela créera un nouveau répertoire de projet avec tous les fichiers et configurations nécessaires pour votre site.

Démarrer le serveur de développement

Lorsque vous travaillez localement, le serveur de développement d’Astro vous permet de prévisualiser votre travail et actualise automatiquement votre navigateur lorsque vous apportez des modifications.

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

Fenêtre de terminal
npm run dev

Un message indiquant l’URL de votre aperçu local s’affichera dans votre terminal. Ouvrez cette URL pour commencer à naviguer sur votre site.

Ajouter du contenu

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

Formats de fichiers

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 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 :

  • Directorysrc/
    • Directorycontent/
      • Directorydocs/
        • Directoryguides/
          • faq.md
        • hello-world.md

Frontmatter avec sûreté du typage

Toutes les pages Starlight partagent un ensemble commun de propriétés du frontmatter personnalisable pour contrôler l’apparence de la page :

---
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.

Prochaines étapes

Mettre à jour Starlight

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 :

Fenêtre de terminal
npx @astrojs/upgrade

Consultez le journal des modifications de Starlight pour une liste complète des modifications apportées à chaque version.

Dépannage de Starlight

Utilisez les pages de référence de configuration de projet et de configuration du frontmatter pour chaque page pour vous assurer que votre site Starlight est configuré et fonctionne correctement. Consultez les guides de la barre latérale pour vous aider à ajouter du contenu et à personnaliser votre site Starlight.

Si vous ne trouvez pas votre réponse dans cette documentation, merci de consulter la documentation d’Astro pour la documentation complète d’Astro. Votre question peut être résolue en comprenant comment Astro fonctionne de manière générale, sous ce thème Starlight.

Vous pouvez également vérifier tous les problèmes connus de Starlight sur GitHub et obtenir de l’aide dans le Discord Astro de notre communauté active et sympathique ! Publiez des questions dans notre forum #support avec le tag “starlight” ou visiter notre canal dédié #starlight pour discuter des développements en cours et plus encore !