Mise en route
Créer un nouveau projet
Starlight est un thème de documentation complet construit sur le framework Astro.
Vous pouvez créer un nouveau projet Astro + Starlight en utilisant la commande suivante :
# créer un nouveau projet avec npm
npm create astro@latest -- --template starlight
# créer un nouveau projet avec pnpm
pnpm create astro --template starlight
# créer un nouveau projet avec 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.
Créer du contenu avec Starlight
Starlight est conçu 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. (Vous pouvez ajouter la prise en charge de Markdoc en installant l’intégration expérimentale Astro Markdoc integration.)
Ajouter des pages
Ajoutez automatiquement de nouvelles pages à votre site en créant des fichiers .md
ou .mdx
dans src/content/docs/
. Ajoutez des sous-dossiers pour organiser vos fichiers, et pour créer plusieurs segments de chemin :
src/content/docs/hello-world.md => votre-site.com/hello-world
src/content/docs/guides/faq.md => votre-site.com/guides/faq
Type-safe frontmatter
Toutes les pages Starlight partagent un ensemble commun de propriétés de présentation 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.
Déployer votre site web Starlight
Une fois que vous avez créé et personnalisé votre site Web Starlight, vous pouvez le déployer sur un serveur Web ou une plateforme d’hébergement de votre choix, y compris Netlify, Vercel, GitHub Pages et bien d’autres.
Pour en savoir plus sur le déploiement d’un site Astro, consultez la documentation Astro
Dépannage de Starlight
Les informations configuration de projet et configuration du frontmatter de la page individuelle pour Starlight sont disponibles dans la section Référence de ce site. Utilisez ces pages pour vous assurer que votre site Starlight est configuré et fonctionne correctement.
Utilisez la liste croissante de guides dans 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, veuillez consulter la documentation complète d’Astro. Votre question peut être résolue en comprenant comment Astro fonctionne en général, sous ce thème Starlight.
Vous pouvez également obtenir de l’aide dans le Discord Astro de notre communauté active et sympathique ! Vous pouvez poster des questions dans notre forum #support
ou visiter notre canal dédié #starlight
pour discuter des développements en cours et plus encore !