Modules d'extension et outils

Modules d’extension

Les modules d’extension peuvent personnaliser la configuration, l’interface utilisateur et le comportement de Starlight, tout en étant faciles à partager et à réutiliser. Étendez votre site avec des modules d’extension officiels maintenus par l’équipe Starlight et des modules d’extension communautaires maintenus par les utilisateurs de Starlight.

Modules d’extension officiels

Algolia DocSearchRemplacer Pagefind, le système de recherche par défaut, par Algolia DocSearch.

Modules d’extension communautaires

starlight-links-validatorVérifier la validité des liens dans vos pages Starlight.

starlight-typedocGénérer des pages Starlight à partir de TypeScript en utilisant TypeDoc.

starlight-blogAjouter un blogue à votre site de documentation.

starlight-openapiCréer des pages de documentation à partir de spécifications OpenAPI/Swagger.

starlight-obsidianPublier vos coffres (vaults) Obsidian sur votre site Starlight.

starlight-image-zoomAjouter des fonctionnalités de zoom aux images de votre documentation.

starlight-view-modesAjouter différents modes d'affichage à votre site web de documentation.

starlight-versionsVersionner vos pages de documentation Starlight.

star-warpAccéder aux résultats de recherche de votre documentation à la vitesse de la lumière.

starlight-heading-badgesAjouter des badges à vos en-têtes Markdown et MDX.

starlight-site-graphAjouter un graphe interactif de votre site dans la barre latérale de votre page.

starlight-sidebar-topicsDiviser votre documentation en différentes sections, chacune ayant sa propre barre latérale.

starlight-cooler-creditAjouter de jolis crédits pour Starlight ou Astro en bas de la table des matières.

starlight-giscusAjouter des commentaires via Giscus à votre site de documentation.

starlight-videosEnrichir votre documentation avec des guides et des cours au format vidéo.

starlight-kbdDocumenter facilement des raccourcis clavier.

starlight-auto-sidebarModifier vos groupes de barre latérale générés automatiquement.

starlight-llms-txtAjouter des fichiers llms.txt à votre site de documentation basé sur llmstxt.org.

starlight-toc-overview-customizerPersonnaliser la table des matières de Starlight avec un libellé de vue d'ensemble personnalisable.

starlight-markdown-blocksÉtendre la syntaxe Markdown des encarts de Starlight avec des types de blocs personnalisés.

starlight-fullview-modeRéduire les barres latérales et élargir le contenu pour une expérience plein écran.

starlight-scroll-to-topAjouter un bouton de retour en haut de page à votre site de documentation.

starlight-codeblock-fullscreenAjouter la fonctionnalité de basculement en plein écran aux blocs Expressive Code de votre documentation.

starlight-auto-draftsAjuster le comportement par défaut des ébauches et supprimer automatiquement de la barre latérale les liens vers les ébauches en mode production.

starlight-contextual-menuAjouter un menu contextuel à votre documentation Starlight.

starlight-changelogsAfficher les journaux des modifications au côté de la documentation de votre projet.

starlight-github-alertsAfficher les alertes GitHub sous forme d'encarts Starlight.

starlight-page-actionsAjoute des boutons d'action aux pages de votre documentation.

starlight-docsearch-typesenseUne alternative au module d'extension officiel Algolia DocSearch reposant sur Typesense.

starlight-sidebar-swipeRendre la barre latérale gauche accessible par glissement sur les appareils mobiles comme sur Discord Mobile.

starlight-plugin-iconsAjouter des icônes à Astro Starlight : barre latérale, blocs de code, arborescence de fichiers.

starlight-ui-tweaksÉtend les composants natifs avec des liens de navigation personnalisés, des publicités, des pieds de page axés marketing et un bouton de thème plus épuré.

starlight-tagsAjouter des étiquettes aux pages de votre documentation Starlight pour organiser et faciliter la recherche de contenu.

starlight-copy-buttonCopier une page de documentation complète au format Markdown à l'aide d'un élégant bouton dans le titre de la page.

starlight-telescopeAccéder rapidement à n'importe quelle page de votre documentation Starlight grâce à la recherche approximative et à la navigation au clavier.

starlight-announcementAjouter des bannières d'annonce améliorées incluant la possibilité de les fermer, des variantes, une planification et un ciblage de page pour votre documentation Starlight.

@gesslar/starlight-class-browserEnsemble de composants pour la documentation d'API, dans le style de Swagger, qui affiche la documentation des classes, des méthodes, des propriétés et des types avec une coloration syntaxique adaptée au thème, le tout dans le DOM principal.

starlight-base-pathPréfixer automatiquement le chemin de base configuré aux liens présents dans votre contenu.

starlight-recipesModule d'extension Starlight pour créer un site web de recettes.

Outils et intégrations communautaires

Ces outils et intégrations communautaires peuvent être utilisés pour ajouter des fonctionnalités à votre site Starlight.

FeelBackAjouter un système de retour d'expérience utilisateur à vos pages de documentation.

notion-to-astroConvertir des exports Notion en documentation Astro Starlight

astro-live-codeAfficher vos blocs de code MDX sous forme de composants interactifs

starlight-i18nExtension Visual Studio Code pour aider à traduire les pages Starlight.

starlight-package-managersAffiche rapidement les commandes liées à npm pour plusieurs gestionnaires de paquets.

starlight-showcasesEnsemble de composants Starlight permettant de créer des pages vitrines.

@hideoo/starlight-pluginUn générateur pour rapidement créer des modules d'extension Starlight.

starlight-to-pdfUn outil en ligne de commande pour convertir des sites web Starlight en fichiers PDF.

astro-plantumlGénérer le contenu PlantUML dans les blocs de code Markdown.

astro-mermaidGénérer du contenu Mermaid côté client dans des blocs de code Markdown.

astro-d2Transformer des blocs de code Markdown utilisant D2 en diagrammes.

starlight-linksExtension Visual Studio Code fournissant IntelliSense pour les liens présents dans les contenus Markdown et MDX de Starlight.

contentisland-cliConnecter et synchroniser votre projet Starlight avec le CMS headless Content Island pour modifier et gérer votre documentation.

starlight-sidebar-topics-dropdownDiviser vos pages de documentation en plusieurs sous-pages et passer de l'une à l'autre à l'aide d'un menu déroulant dans la barre latérale.

starlight-save-file-componentAfficher rapidement un lien vers une ressource téléchargeable sur votre site Starlight.

starlight-contributor-listAfficher la liste de tous les contributeurs de votre projet.

starlight-md-txtExposer vos pages de documentation Starlight sous forme de Markdown brut adapté aux agents, via des URL se terminant par .md.txt.

Axiom Studio pour StarlightUn éditeur fonctionnant localement dans le navigateur pour modifier les pages Markdown et MDX, gérer le frontmatter et prévisualiser la documentation Starlight sans toucher aux fichiers sources.