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 du contenu cité ou des énoncés mis en évidence.

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

Règle horizontale

Séparateur visuel entre les sections.

Formatage en ligne

Sélectionnez du texte pour appliquer une mise en forme avec la barre d’outils ou les raccourcis clavier :

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

• Italique (Ctrl/Cmd+I) — mise en valeur discrète ou titres

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

• Surlignage — attirer l’attention sur des 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 suites.

• É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é

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

Procédures

Étapes

Procédure numérotée dont chaque étape comporte un titre et un corps de texte. Plus visuelle qu’une simple liste numérotée.

À utiliser pour des procédures complexes, des tutoriels ou des workflows pour 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 des comparaisons, des grilles de fonctionnalités ou pour séparer du contenu lié.

Carte

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

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

Bouton

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

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

Blocs de code

Bloc de code unique

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

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

Multi-code

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

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

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

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

Contenu repliable

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 de contexte facultatives ou le dépannage dont tous les lecteurs n’ont pas besoin.

Média

Image

Ajoutez-la en faisant glisser des fichiers dans l’éditeur, en les collant depuis le presse-papiers ou via le menu slash. Prend en charge PNG, JPEG, GIF et WebP. Après avoir inséré une image, survolez-la puis cliquez sur Edit pour la recadrer ou l’annoter. Voir Modifier les 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 Video 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 dans 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 MB

• Durée maximale : 2 hours

Si une vidéo ne respecte pas ces exigences, vous verrez une erreur de validation intégrée dans le contrôle de téléversement. Les erreurs courantes incluent :

• 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 MB

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

• 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

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 autre service qui vous fournit un code d’intégration. Appuyez sur / et sélectionnez Custom HTML dans le menu des blocs.

Notes latérales

Encadré

Paragraphe mis en évidence pour les conseils, avertissements ou 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