Markdown et MDX
Cette section fournit une référence complète pour la syntaxe Markdown et MDX prise en charge par Archbee, accompagnée d’exemples pratiques pour chaque composant pris en charge. Si vous utilisez Git Sync ou suivez un flux de travail docs-as-code, et que vous préférez rédiger ou modifier la documentation directement dans votre éditeur de code ou votre dépôt, cette section est faite pour vous.
Markdown standard
Archbee prend entièrement en charge la syntaxe Markdown standard pour créer et formater la documentation. Vous pouvez utiliser des éléments familiers tels que les titres, listes, images, tableaux, citations, blocs de code et bien plus encore, sans configuration supplémentaire.
Composants MDX
En plus du Markdown standard, Archbee étend le langage avec des composants MDX personnalisés qui permettent de créer des expériences de documentation plus riches. Ces composants incluent des onglets, encadrés d’information, workflows, endpoints API, grilles de liens, sections extensibles et autres mises en page interactives.
ℹ️ Projets connectés à Git
Lorsqu’un dépôt connecté à Git est synchronisé avec Archbee, les fichiers Markdown (.md) sont automatiquement traités comme MDX (.mdx). La syntaxe Markdown existante reste entièrement compatible, de sorte que votre contenu actuel continue de s’afficher correctement tout en vous donnant accès à la bibliothèque de composants étendue d’Archbee.