Composants Starlight
Recommandee- Avantage
- Stable, coherent avec le theme, sans maintenance locale.
- Limite
- Ne couvre pas les conventions metier du systeme documentaire.
- Note
- Choix par defaut pour les patterns generiques.
Le projet ne doit pas devenir une application UI complexe. Les composants doivent rendre la lecture, la decision et la maintenance plus faciles sans ajouter de dependance inutile.
Ordre de preference :
| Besoin | Composant recommande | Origine | Usage cible |
|---|---|---|---|
| Resume executif | ExecutiveSummary | Local | Debut de document long, note strategique, reference durable |
| Statut de page | StatusBanner | Local | Page active, brouillon important, archive commentee |
| Statut projet | ProjectStatus | Local | Page d’accueil projet ou fiche de suivi |
| Decision | DecisionBox | Local | Arbitrage, choix propose, validation, rejet |
| Journal de decisions | DecisionLog | Local | Plusieurs decisions datees a comparer |
| Comparaison d’options | OptionMatrix | Local | Arbitrage multi-options avec recommandation |
| Preuve ou hypothese | EvidenceBox | Local | Fait, hypothese, source et niveau de confiance |
| Metadonnees document | DocumentMeta | Local | Statut, responsable, date, tags |
| Chronologie | Timeline | Local | Jalons, historique projet, sequence d’evenements |
| Risque critique | WarningBox | Local | Point bloquant, limite forte, risque operationnel |
| Prochaines actions | ActionList | Local | Suite operationnelle avec responsable, echeance ou statut |
| Sources structurees | SourceList | Local | Bas de page avec references externes |
| Reference courte | ReferenceCard | Local | Carte source ou ressource isolee |
| Note generique | Aside | Starlight | Note, conseil, avertissement non metier |
| Badge court | Badge | Starlight | Statut compact dans tableau ou liste |
| Navigation | LinkCard + CardGrid | Starlight | Index de dossiers, pages ressources, pages d’accueil |
| Procedure | Steps | Starlight | Workflow, runbook, tutoriel pas a pas |
| Arborescence | FileTree | Starlight | Structure de dossiers, conventions de fichiers |
| Variante equivalente | Tabs + TabItem | Starlight | Environnements, options, commandes alternatives |
| Code externe | Code | Starlight | Extrait importe avec ?raw, code genere, comparaison de config |
| Action de navigation | LinkButton | Starlight | Lien principal sur page d’accueil ou guide |
| Situation | Utiliser | Ne pas utiliser |
|---|---|---|
| Note generique, conseil, avertissement simple | Aside Starlight | WarningBox |
| Risque metier ou operationnel fort | WarningBox | Aside generique |
| Navigation vers une page | LinkCard Starlight | ReferenceCard |
| Source externe annotee | ReferenceCard ou SourceList | LinkCard |
| Metadonnees generales | DocumentMeta | ProjectStatus |
| Fiche projet courte | ProjectStatus | DocumentMeta si la page est strictement projet |
| Comparaison d’options | OptionMatrix | Tableau Markdown repetitif |
| Plusieurs decisions datees | DecisionLog | Plusieurs DecisionBox empiles |
| Besoin | Canonique | Alias compatible | Regle |
|---|---|---|---|
| Metadonnees generales | DocumentMeta | Aucun | Standard pour les pages ressources, areas et notes transversales |
| Fiche projet courte | ProjectStatus | DocumentMeta | Garder ProjectStatus uniquement quand la page represente un projet |
| Statut court | DocBadge interne | doc-status-pill CSS | Les pages MDX ne l’importent pas directement |
| Risque operationnel | WarningBox | Aside type="danger" | WarningBox signale un risque metier, pas une note generique |
| Source annotee | ReferenceCard | SourceList | ReferenceCard pour une source isolee, SourceList pour une bibliographie |
| Critere | Regle appliquee |
|---|---|
| Complet | Le kit couvre resume, statut, decision, options, preuves, actions, timeline, sources et navigation via Starlight |
| Optimal | Les statuts, labels et tons sont factorises dans un modele partage |
| Design | Les composants utilisent des surfaces, badges, marqueurs et separateurs coherents en light et dark mode |
| Sans redondance | Chaque composant local a une limite explicite face aux composants Starlight |
| Pertinent | Les composants locaux servent uniquement les conventions documentaires du projet |
Le rendu reste statique, rapide et compatible avec MDX sans runtime client.
La maintenance reste faible et les conventions locales restent lisibles.
Evaluation initiale a 7.4 sur 10.
Ajout des composants manquants et des regles anti-redondance.
Appliquer les composants aux prochaines pages longues.
Documentation
Reference principale pour les composants natifs disponibles dans les pages MDX.
| Plugin | Utilite | Priorite |
|---|---|---|
starlight-links-validator | Controler les liens casses | Haute quand les sources externes augmentent |
starlight-image-zoom | Agrandir captures et schemas | Moyenne, utile avec beaucoup d’images |
starlight-llms-txt | Generer des contextes llms.txt pour assistants IA | Moyenne, pertinent si le site sert de base IA |
starlight-tags | Exploiter les tags dans la navigation | Basse tant que les tags restent simples |
astro-mermaid ou astro-d2 | Rendre des diagrammes depuis les blocs Markdown | Moyenne si les workflows deviennent graphiques |
import { Aside, Badge, CardGrid, LinkCard, Steps } from '@astrojs/starlight/components';import ExecutiveSummary from '../../../components/ExecutiveSummary.astro';import DecisionBox from '../../../components/DecisionBox.astro';import DocumentMeta from '../../../components/DocumentMeta.astro';import DecisionLog from '../../../components/DecisionLog.astro';import OptionMatrix from '../../../components/OptionMatrix.astro';import EvidenceBox from '../../../components/EvidenceBox.astro';import Timeline from '../../../components/Timeline.astro';<ActionList headingLevel={3} actions={actions} /><DecisionLog headingLevel={3} decisions={decisions} /><OptionMatrix headingLevel={3} options={options} /><Timeline headingLevel={3} items={items} />Tepe
Tepe
Tepe
Reference pour importer et utiliser les composants dans les fichiers MDX.
Point d entree vers les cartes, badges, asides, file tree, steps, tabs, code et boutons.
Catalogue des plugins officiels et communautaires pertinents pour une documentation Starlight.
Reference pour l usage des composants Astro et UI dans les fichiers MDX.