Blocs de contenu

Appuyez sur / dans l’éditeur pour ouvrir le menu des blocs et insérer n’importe quel bloc de contenu.

Blocs de texte

Paragraphes et titres

Les paragraphes sont le bloc de texte par défaut. Utilisez H2 pour les sections principales et H3 pour les sous-sections.

Citation

Pour les contenus cités ou les déclarations mises en évidence.

« La documentation est une lettre d’amour que vous écrivez à votre futur vous-même. »

Ligne horizontale

Séparateur visuel entre les sections.

Mise en forme inline

Sélectionnez du texte pour lui appliquer une mise en forme à l’aide de la barre d’outils ou des raccourcis clavier :

• Gras (Ctrl/Cmd+B) — mise en évidence

• Italique (Ctrl/Cmd+I) — accentuation subtile ou titres

• Code (Ctrl/Cmd+E) — code inline, commandes ou noms de fichiers

Listes

Listes à puces et numérotées

Les listes à puces servent aux éléments non ordonnés, et les listes numérotées aux séquences.

• Premier élément

• Deuxième élément

1. Première étape

2. Deuxième étape

Liste de tâches

Cases à cocher interactives que les lecteurs peuvent marquer comme terminées. La progression est conservée dans leur navigateur.

• Créer une collection

• Rédiger votre premier article

• Connecter un domaine personnalisé

À utiliser pour les listes de contrôle de configuration, les prérequis ou les procédures que les lecteurs suivent eux-mêmes.

Procédures

Étapes

Procédure numérotée dans laquelle chaque étape possède un titre et un corps de texte. Plus visuelle qu’une simple liste numérotée.

À utiliser pour les procédures complexes, les tutoriels ou les workflows dans lesquels chaque étape nécessite des instructions détaillées.

Blocs de mise en page

Colonnes

Contenu côte à côte. Choisissez entre 2 ou 3 colonnes lorsque vous insérez le bloc.

À utiliser pour les comparaisons, les grilles de fonctionnalités ou la séparation de contenus associés.

Carte

Encadré mis en évidence renvoyant vers un autre article. Ajoutez une icône via le sélecteur d’icônes.

À utiliser pour les liens vers des articles associés ou la navigation vers l’étape suivante.

Bouton

Bouton d’appel à l’action unique pour les liens externes.

À utiliser pour les actions externes principales. Un seul par article au maximum.

Blocs de code

Bloc de code unique

Code avec coloration syntaxique. Ajoutez un nom de fichier si cela est utile.

function greet(name) {
  return `Hello, ${name}!`;
}

Code multiple

Même code dans plusieurs langages avec changement d’onglet.

// JavaScript
fetch('/api/articles')
  .then(res => res.json())

# Python
import requests
response = requests.get('/api/articles')

À utiliser pour les exemples d’API avec des SDK dans plusieurs langages.

Contenu réductible

Détails

Contenu qui se déploie lorsque l’on clique dessus. Le lecteur ne voit que le résumé tant qu’il ne l’a pas ouvert.

À utiliser pour les FAQ, le contexte complémentaire facultatif ou le dépannage dont tous les lecteurs n’ont pas besoin.

Médias

Image

Ajoutez une image en faisant glisser des fichiers dans l’éditeur, en la collant depuis le presse-papiers ou via le menu slash. Les formats PNG, JPEG, GIF et WebP sont pris en charge. Après avoir inséré une image PNG, JPEG ou WebP, survolez-la et cliquez sur Modifier pour la recadrer ou l’annoter. Les images GIF peuvent être insérées, mais pas modifiées. Consultez Modifier des images dans l’éditeur d’articles.

Vidéo

Ajoutez des vidéos en les intégrant depuis une plateforme d’hébergement ou en téléversant directement un fichier. Appuyez sur / et sélectionnez Vidéo dans le menu des blocs, puis choisissez d’intégrer une URL ou de téléverser un fichier.

Intégrer une vidéo

Collez une URL provenant de YouTube, Vimeo, Wistia, Loom ou Tella pour intégrer la vidéo à votre article.

Téléverser une vidéo

Téléversez directement un fichier vidéo depuis votre ordinateur. Les formats pris en charge sont MP4, WebM, MOV et OGG.

Limites de téléversement :

• Taille maximale du fichier : 512 Mo

• Durée maximale : 2 heures

Si une vidéo ne respecte pas ces exigences, une erreur de validation s’affiche dans le contrôle de téléversement. Les erreurs courantes sont les suivantes :

• Type de fichier non pris en charge — téléversez une vidéo MP4, WebM, MOV ou OGG

• Fichier trop volumineux — la taille maximale est de 512 Mo

• Vidéo trop longue — la durée maximale est de 2 heures

• Fichier vide — le fichier vidéo ne contient aucune donnée

• Échec du téléversement — la vidéo n’a pas pu être téléversée, réessayez

Fichier

Hébergez dans l’article un fichier téléchargeable, tel qu’un PDF, une feuille de calcul ou un schéma JSON. Appuyez sur / et sélectionnez Fichier dans le menu des blocs, ou faites glisser un fichier dans l’éditeur. Les lecteurs voient une carte indiquant le nom, le type et la taille du fichier, et peuvent le télécharger depuis le centre d’aide publié ou le Self-Service Widget.

Sur la carte, vous pouvez ajouter une légende, remplacer le fichier, copier son lien public sur static.ferndesk.com ou le supprimer.

Limites de téléversement :

• Taille maximale du fichier : 250 Mo

• Les fichiers vides sont rejetés avant le téléversement.

• Les pages web, les scripts, les SVG et les programmes d’installation sont refusés, car ils s’exécuteraient au lieu d’être téléchargés. Cela inclut notamment .html, .js et .exe.

Les images et les vidéos peuvent être hébergées en tant que fichiers téléchargeables, par exemple une capture d’écran en pleine résolution. Pour les afficher directement dans la page, utilisez les blocs Image ou Vidéo.

HTML personnalisé

Ajoutez du HTML personnalisé pour intégrer des widgets tiers, des formulaires ou d’autres contenus externes provenant de fournisseurs comme Typeform, Calendly, Tally ou de tout service qui vous fournit du code d’intégration. Appuyez sur / et sélectionnez HTML personnalisé dans le menu des blocs.

Notes latérales

Encadré

Paragraphe mis en évidence pour les conseils, les avertissements ou les informations importantes.

Limitez-vous à un ou deux par article. N’en empilez jamais plusieurs.

Données

Tableau

Données structurées en lignes et en colonnes.

Ressources associées

• Comment créer des articles manuellement

• Créer et modifier des articles avec Fern