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

Paragraphe 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 le contenu cité ou les déclarations mises en avant.

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

Filet de séparation

Séparateur visuel entre les sections.

Formatage en ligne

Sélectionnez du texte pour appliquer un formatage avec la barre d'outils ou les raccourcis clavier :

• Gras (Ctrl/Cmd+B) — emphase

• Italique (Ctrl/Cmd+I) — emphase légère ou titres

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

• Surlignage — attire l'attention sur les termes clés

Listes

Listes à puces et numérotées

Listes à puces pour les éléments non ordonnés, listes numérotées pour les séquences.

• Élément un

• Élément deux

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 où chaque étape a un titre et un corps. Plus visuel qu'une simple liste numérotée.

À utiliser pour les procédures complexes, les tutoriels ou les flux de travail où 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 lors de l'insertion du bloc.

À utiliser pour les comparaisons, les grilles de fonctionnalités ou pour diviser du contenu lié.

Carte

Boîte mise 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 connexes 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 une étiquette de nom de fichier si nécessaire.

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

Multi-code

Le 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 pliable

Détails

Contenu qui se développe lorsqu'on clique dessus. Le lecteur ne voit que le résumé jusqu'à ce qu'il l'ouvre.

À utiliser pour les FAQ, les informations contextuelles optionnelles ou le dépannage dont tous les lecteurs n'ont pas besoin.

Médias

Image

Ajoutez des fichiers en les faisant glisser dans l'éditeur, en les collant depuis le presse-papiers ou via le menu slash. Prend en charge PNG, JPEG, GIF et WebP.

Vidéo

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

Intégrer une vidéo

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

Télécharger une vidéo

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

Limites de téléchargement :

• Taille maximale du fichier : 512 Mo

• Durée maximale : 2 heures

Si une vidéo ne répond pas à ces exigences, vous verrez une erreur de validation en ligne dans la commande de téléchargement. Les erreurs courantes incluent :

• Type de fichier non pris en charge — téléchargez 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échargement — la vidéo n'a pas pu être téléchargée, réessayez

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 tout service proposant un code d'intégration. Appuyez sur / et sélectionnez HTML personnalisé dans le menu des blocs.

Notes latérales

Mise en avant

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

Limitez à un ou deux par article. Ne les empilez jamais.

Données

Tableau

Données structurées en lignes et colonnes.

Ressources connexes

• Comment créer des articles manuellement

• Créer et modifier des articles avec Fern