Markdown

Cette page décrit l’éditeur Markdown, qui est disponible dans les projets créés avant l’éditeur unifié. Si votre projet a été créé récemment, vous écrivez Markdown avec le bouton Markdown dans l’éditeur unifié à la place — voir Markdown et HTML dans l’éditeur unifié.

Qu’est-ce que l’éditeur Markdown ?

L’éditeur Markdown est l’une des trois options d’éditeur disponibles dans Document360. Il utilise un style de syntaxe abrégée — appelé Markdown — pour formater le texte, qui est ensuite converti en HTML lors de son rendu sur le site de la base de connaissances.

Markdown est un langage de balisage léger qui vous permet de formater du contenu à l’aide de caractères spéciaux, sans avoir à écrire directement du HTML. Par exemple, taper **text** rend le texte en gras et ## Heading crée un titre de second niveau.

L’éditeur Markdown utilise une mise en page en écran partagé :

• Panneau de gauche — Où vous tapez et appliquez la syntaxe Markdown. La syntaxe prise en charge comme les titres peut apparaître stylisée directement dans ce panneau au fur et à mesure que vous tapez, ce qui est un comportement attendu.
• Panneau de droite — Un aperçu en direct qui montre exactement comment l’article apparaîtra sur le site de la base de connaissances une fois publié.

Vous pouvez activer Défiler pour que les deux cases défilent simultanément pendant que vous écrivez. Cliquez sur Défiler pour désactiver cela.

Quand utiliser l’éditeur Markdown

L’éditeur Markdown fonctionne mieux lorsque :

• Vos articles sont principalement textuels avec un minimum d’éléments multimédias.
• Votre équipe est à l’aise avec la syntaxe Markdown ou le HTML et préfère l’écriture axée sur le clavier.
• Vous devez utiliser des balises HTML personnalisées ou du code en ligne que les éditeurs WYSIWYG ne prennent pas en charge.
• Vous travaillez sur une documentation très codée comme {{ glossaire. API}} références ou guides développeurs.

Si vos articles contiennent beaucoup d’images, de vidéos, de tableaux ou une mise en forme riche, l’éditeur WYSIWYG avancé peut mieux vous convenir. → Comparer les éditeurs dans Document360

Bases du Markdown

Markdown utilise des caractères simples pour formater le texte. Voici une référence rapide à la syntaxe la plus couramment utilisée :

Pour la référence complète de la syntaxe Markdown, voir → Syntaxe de base Markdown

La barre d’outils Markdown

La barre d’outils Markdown permet un accès rapide aux options de mise en forme sans taper manuellement la syntaxe. Les principales options de la barre d’outils incluent :

Convertir un article Markdown en éditeur WYSIWYG avancé

Si vous souhaitez déplacer un article Markdown vers l’éditeur WYSIWYG avancé — pour accéder à des blocs de contenu plus riches, à Eddy AI et à plus d’options de mise en forme — vous pouvez le convertir au niveau de l’article.

1. Ouvrez l’article dans l’éditeur Markdown.
2. Cliquez sur l’icône Plus (•••) en haut à droite de l’éditeur.
3. Sélectionnez plus d’options d’article. Le panneau de paramètres d’article apparaîtra.
4. Naviguez vers l’onglet Éditeur .
5. Sélectionnez l’éditeur WYSIWYG avancé.
6. Sélectionnez la case Êtes-vous sûr de vouloir continuer ? pour confirmer.
7. Cliquez sur Enregistrer.

L’article sera converti en éditeur WYSIWYG avancé et s’ouvrira immédiatement dans le nouveau rédacteur.

À quoi s’attendre après la conversion

• Tout le contenu textuel, les titres, les listes et la mise en forme de base sont conservés.
• Certaines syntaxes spécifiques à Markdown non prises en charge dans l’éditeur WYSIWYG avancé — comme les tables Markdown — devront être revues et reconstruites à l’aide des outils intégrés de l’éditeur après conversion.
• Vous pouvez définir l’éditeur WYSIWYG avancé comme référence par défaut pour tous les nouveaux articles depuis les Paramètres > le portail de la base de connaissances > l’éditeur > général. Cela n’affecte pas les articles Markdown existants.

Meilleures pratiques

• Utilisez la barre d’outils si vous débutez sur Markdown — elle insère la syntaxe automatiquement, donc vous n’avez pas besoin de mémoriser les commandes.
• Écrivez la syntaxe avec soin — de petites erreurs comme un espace manquant ou un caractère supplémentaire empêcheront la mise en forme correcte de s’afficher.
• Utilisez fréquemment le panneau d’aperçu en direct pour vérifier à quoi ressemblera le contenu avant la publication, surtout pour les éléments complexes comme les tables et les blocs de code.
• Évitez de mélanger inutilement Markdown et HTML — bien que le HTML soit pris en charge, en abuser peut entraîner des incohérences dans le rendu.
• Envisagez de convertir vers l’éditeur WYSIWYG avancé si votre article devient plus complexe et nécessite des blocs de contenu tels que des onglets, accordéons, callouts ou éléments interactifs.

FAQ