Skip to content

Composants MDX

Statut
Actif
Responsable
Tepe
Mise a jour
Tags
mdxstarlightcomposants

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 :

  1. Markdown natif quand la structure suffit.
  2. Composant Starlight natif quand le besoin est documentaire et standard.
  3. Composant local Astro quand le besoin correspond a une regle documentaire du projet.
  4. Plugin Starlight seulement quand le gain est durable et transversal.
BesoinComposant recommandeOrigineUsage cible
Resume executifExecutiveSummaryLocalDebut de document long, note strategique, reference durable
Statut de pageStatusBannerLocalPage active, brouillon important, archive commentee
Statut projetProjectStatusLocalPage d’accueil projet ou fiche de suivi
DecisionDecisionBoxLocalArbitrage, choix propose, validation, rejet
Journal de decisionsDecisionLogLocalPlusieurs decisions datees a comparer
Comparaison d’optionsOptionMatrixLocalArbitrage multi-options avec recommandation
Preuve ou hypotheseEvidenceBoxLocalFait, hypothese, source et niveau de confiance
Metadonnees documentDocumentMetaLocalStatut, responsable, date, tags
ChronologieTimelineLocalJalons, historique projet, sequence d’evenements
Risque critiqueWarningBoxLocalPoint bloquant, limite forte, risque operationnel
Prochaines actionsActionListLocalSuite operationnelle avec responsable, echeance ou statut
Sources structureesSourceListLocalBas de page avec references externes
Reference courteReferenceCardLocalCarte source ou ressource isolee
Note generiqueAsideStarlightNote, conseil, avertissement non metier
Badge courtBadgeStarlightStatut compact dans tableau ou liste
NavigationLinkCard + CardGridStarlightIndex de dossiers, pages ressources, pages d’accueil
ProcedureStepsStarlightWorkflow, runbook, tutoriel pas a pas
ArborescenceFileTreeStarlightStructure de dossiers, conventions de fichiers
Variante equivalenteTabs + TabItemStarlightEnvironnements, options, commandes alternatives
Code externeCodeStarlightExtrait importe avec ?raw, code genere, comparaison de config
Action de navigationLinkButtonStarlightLien principal sur page d’accueil ou guide
SituationUtiliserNe pas utiliser
Note generique, conseil, avertissement simpleAside StarlightWarningBox
Risque metier ou operationnel fortWarningBoxAside generique
Navigation vers une pageLinkCard StarlightReferenceCard
Source externe annoteeReferenceCard ou SourceListLinkCard
Metadonnees generalesDocumentMetaProjectStatus
Fiche projet courteProjectStatusDocumentMeta si la page est strictement projet
Comparaison d’optionsOptionMatrixTableau Markdown repetitif
Plusieurs decisions dateesDecisionLogPlusieurs DecisionBox empiles

Composants canoniques et aliases compatibles

Section titled “Composants canoniques et aliases compatibles”
BesoinCanoniqueAlias compatibleRegle
Metadonnees generalesDocumentMetaAucunStandard pour les pages ressources, areas et notes transversales
Fiche projet courteProjectStatusDocumentMetaGarder ProjectStatus uniquement quand la page represente un projet
Statut courtDocBadge internedoc-status-pill CSSLes pages MDX ne l’importent pas directement
Risque operationnelWarningBoxAside type="danger"WarningBox signale un risque metier, pas une note generique
Source annoteeReferenceCardSourceListReferenceCard pour une source isolee, SourceList pour une bibliographie
CritereRegle appliquee
CompletLe kit couvre resume, statut, decision, options, preuves, actions, timeline, sources et navigation via Starlight
OptimalLes statuts, labels et tons sont factorises dans un modele partage
DesignLes composants utilisent des surfaces, badges, marqueurs et separateurs coherents en light et dark mode
Sans redondanceChaque composant local a une limite explicite face aux composants Starlight
PertinentLes composants locaux servent uniquement les conventions documentaires du projet

Journal des decisions

  1. Conserver Astro pur pour les composants documentaires

    Le rendu reste statique, rapide et compatible avec MDX sans runtime client.

    Validee
  2. Differer les plugins tant que le besoin transversal n est pas prouve

    La maintenance reste faible et les conventions locales restent lisibles.

    Proposee

Options

Composants locaux

Possible
Avantage
Traduit les regles documentaires propres au projet.
Limite
Demande une discipline de maintenance.
Note
A utiliser quand une regle revient dans plusieurs pages.

Nouvelle librairie UI

Rejetee
Avantage
Large catalogue pret a l emploi.
Limite
Ajoute du poids et des conventions inutiles pour une base documentaire.

Chronologie

  1. Audit des composants v1Termine

    Evaluation initiale a 7.4 sur 10.

  2. Kit V2 documenteEn cours

    Ajout des composants manquants et des regles anti-redondance.

  3. Validation par usage reelA venir

    Appliquer les composants aux prochaines pages longues.

Documentation

Starlight Components

Reference principale pour les composants natifs disponibles dans les pages MDX.

PluginUtilitePriorite
starlight-links-validatorControler les liens cassesHaute quand les sources externes augmentent
starlight-image-zoomAgrandir captures et schemasMoyenne, utile avec beaucoup d’images
starlight-llms-txtGenerer des contextes llms.txt pour assistants IAMoyenne, pertinent si le site sert de base IA
starlight-tagsExploiter les tags dans la navigationBasse tant que les tags restent simples
astro-mermaid ou astro-d2Rendre des diagrammes depuis les blocs MarkdownMoyenne 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} />

Prochaines actions

  1. Utiliser LinkCard et CardGrid dans les pages index de ressources

    Tepe

    A faire
  2. Remplacer les listes de procedures longues par Steps quand le contenu est stable

    Tepe

    A faire
  3. Utiliser DocumentMeta pour les prochaines references transversales

    Tepe

    En cours

Sources principales

  1. Starlight - Using Components

    Reference pour importer et utiliser les composants dans les fichiers MDX.

  2. Starlight - Components

    Point d entree vers les cartes, badges, asides, file tree, steps, tabs, code et boutons.

  3. Starlight - Plugins and Integrations

    Catalogue des plugins officiels et communautaires pertinents pour une documentation Starlight.

  4. Astro - MDX Integration

    Reference pour l usage des composants Astro et UI dans les fichiers MDX.