AccueilComponentsMarkdownDescription

MarkdownDescription

Affiche du contenu Markdown enrichi : titres, listes, code inline, blocs de code, tableaux.
core
Default

Titre principal

Paragraphe avec du texte en gras et du texte en italique.

Titres et listes

Liste à puces

•Premier élément •Deuxième élément •Troisième élément

Code

Code inline : const id = 'user_id_1'; Bloc de code TypeScript :
const greet = (name: string): string => {
return `Bonjour, ${name} !`;
};

Tableau

Colonne AColonne BColonne C
Cellule 1Cellule 2Cellule 3
Cellule 4Cellule 5Cellule 6

Liens et citations

Voir la documentation Markdown pour la syntaxe complète.
Une citation met en avant un point important, comme cet avertissement.
tsx
export const Default = () => <MarkdownDescription>{FULL_MARKDOWN}</MarkdownDescription>;
SimpleText
Paragraphe simple avec du texte en gras et du texte en italique.tsx
export const SimpleText = () => (
<MarkdownDescription>{'Paragraphe simple avec du texte **en gras** et du texte *en italique*.'}</MarkdownDescription>
);
WithCodeBlock
Utilisez npm install pour installer les dépendances.
npm install @alveole/components
tsx
export const WithCodeBlock = () => (
<MarkdownDescription>{`Utilisez \`npm install\` pour installer les dépendances.
\`\`\`bash
npm install @alveole/components
\`\`\``}</MarkdownDescription>
);
WithTable
NomTypeDescription
childrenstringContenu Markdown à afficher
tsx
export const WithTable = () => (
<MarkdownDescription>{`| Nom | Type | Description |
|-----|------|-------------|
| children | string | Contenu Markdown à afficher |`}</MarkdownDescription>
);
WithWideTable
Faites défiler le tableau horizontalement pour voir toutes les colonnes.
OutilApplicationEnvironnementPermissionDescription
variables_listcaptive-dashboardproductionLectureListe les variables de l'application
scheduled_tasks_createcaptive-dashboardstagingÉcritureCrée une tâche planifiée
application_restartcaptive-platformproductionAdministrationRedémarre l'application
tsx
export const WithWideTable = () => (
<Box style={{ width: 320, maxWidth: '100%', minWidth: 0 }}>
<MarkdownDescription>{`Faites défiler le tableau horizontalement pour voir toutes les colonnes.
| Outil | Application | Environnement | Permission | Description |
|-------|-------------|---------------|------------|-------------|
| variables_list | captive-dashboard | production | Lecture | Liste les variables de l'application |
| scheduled_tasks_create | captive-dashboard | staging | Écriture | Crée une tâche planifiée |
| application_restart | captive-platform | production | Administration | Redémarre l'application |`}</MarkdownDescription>
</Box>
);
Voir la documentation Markdown pour la syntaxe complète.tsx
export const WithLink = () => (
<MarkdownDescription>
{'Voir la [documentation Markdown](https://www.markdownguide.org/) pour la syntaxe complète.'}
</MarkdownDescription>
);
WithBlockquote
Une citation met en avant un point important, comme cet avertissement.
tsx
export const WithBlockquote = () => (
<MarkdownDescription>
{'> Une citation met en avant un point important, comme cet avertissement.'}
</MarkdownDescription>
);
Alveole UI Kit — v2.0.0-alpha.30