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 :

npm

npm create astro@latest -- --template starlight

pnpm

pnpm create astro --template starlight

Yarn

yarn create astro --template starlight

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

Voir en action

Essayez Starlight dans votre navigateur : ouvrir le modèle sur StackBlitz.

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 :

npm

npm run dev

pnpm

pnpm dev

Yarn

yarn 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 !

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

Pour en savoir plus sur le routage par fichier et la prise en charge des fichiers MDX et Markdoc, consultez le guide « Pages ».

Prochaines étapes

• Configurer : Découvrez les options courantes dans « Personnaliser Starlight ».
• Naviguer : Configurez votre barre latérale avec le guide « Barre latérale de navigation ».
• Composants : Découvrez les cartes, les onglets et d’autres composants intégrés dans le guide « Composants ».
• Déployer : Publiez votre travail avec le guide « Déployer votre site » dans la documentation d’Astro.

Mettre à jour Starlight

Astuce

Comme Starlight est un logiciel en version bêta, il y aura des mises à jour et des améliorations fréquentes. 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 :

npm

npx @astrojs/upgrade

pnpm

pnpm dlx @astrojs/upgrade

Yarn

yarn dlx @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 !