SUR CETTE PAGE

Accéder au contenu principal

CETTE PAGE VOUS A-T-ELLE AIDÉ ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Utiliser Markdown

Markdown est un langage de balisage simple qui vous permet d'améliorer le texte brut en y ajoutant un formatage.

Pourquoi utiliser Markdown ?

Avec Markdown, vous pouvez faire ressortir le texte brut en ajoutant des en-têtes, des caractères gras, des caractères en italique, des images, des liens, etc.

API Designer simplifie l'utilisation de Markdown, même pour les débutants. Grâce à l'éditeur intégré, vous n'avez pas besoin de connaître la syntaxe Markdown pour l'utiliser.

Il existe différents types de Markdown, et API Designer supporte CommonMark, les tableaux et les emojis, ainsi que quelques autres.

Où pouvez-vous utiliser Markdown ?

Vous pouvez utiliser Markdown dans tous les champs de description ainsi que dans les blocs de texte.

Vous pouvez savoir si Markdown est supporté lorsque la barre d'outils Markdown s'affiche en haut de la zone de texte.

Lorsque vous écrivez la description d'une API, par exemple, la barre d'outils Markdown s'affiche en haut de la zone de saisie de texte.

Les zones de texte supportant Markdown vous permettent de saisir un texte en mode plein écran, avec la vue Markdown et la vue rendue (obtenue) ouvertes en même temps. Cliquez sur l'icône de division de fenêtre dans la partie droite de la barre d'outils Markdown.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici