Contenu en ligne

Utilisez la palette en ligne pour ajouter des images, des liens, des formules mathématiques & TeX, et plus

Ajoutez des éléments en ligne à votre contenu.

La palette en ligne vous permet d'ajouter rapidement du contenu supplémentaire à votre bloc de texte sans quitter le clavier. Appuyez simplement sur / sur n'importe quel bloc de texte pour ouvrir la palette en ligne. La barre oblique sera remplacée par le contenu que vous choisissez d'insérer.

Annotations

Avec les annotations, vous pouvez ajouter un contexte supplémentaire à vos mots sans interrompre le fil de pensée du lecteur. Vous pouvez les utiliser pour expliquer le sens d'un mot, insérer des informations supplémentaires, et plus encore. Les lecteurs peuvent survoler le texte annoté pour afficher l'annotation au-dessus du texte.

Créer une annotation

Pour créer une annotation, sélectionnez le texte que vous souhaitez annoter et cliquez sur le Annoter option dans le menu contextuel. Une fois que vous avez écrit votre annotation, cliquez en dehors pour continuer à écrire dans le bloc de texte.

Représentation Markdown

Vous pouvez écrire du contenu en notes de bas de page Markdown pour les ajouter comme annotations dans GitBook. Les indicateurs de note de bas de page doivent apparaître immédiatement après le mot que vous souhaitez annoter ; ils ne doivent pas apparaître après des signes de ponctuation ou d'autres symboles.

Voici une note de bas de page simple[^1], et voici une plus longue[^bignote].

[^1]: Ceci est la première note de bas de page.

[^bignote]: En voici une avec plusieurs paragraphes et du code.

    Indentez les paragraphes pour les inclure dans la note de bas de page.

    `{ mon code }`

    Ajoutez autant de paragraphes que vous le souhaitez.

Images

Les images en ligne seront placées à côté de votre texte sur la page.

Par défaut, les images sont définies à leur taille d'origine avec une largeur maximale de 300 px. Vous pouvez modifier la taille en cliquant sur l'image pour ouvrir la palette de formatage, puis en choisissant l'une des trois options :

1. Taille en ligne : L'image est proportionnée à la taille de la police — idéal pour les icônes et les badges.

2. Taille originale : L'image restera en ligne à sa taille d'origine, avec une largeur maximale de 300 pixels.

3. Convertir en bloc : Cela transforme une image en ligne en un bloc d'image, qui est aussi large que votre contenu.

Les blocs d'image offrent plus d'options, y compris davantage de tailles et la possibilité d'ajouter une légende — mais n'apparaîtront pas en ligne avec votre texte.

Représentation en Markdown

Voici une image en ligne : <img src=".gitbook/assets/GitBook - Dark.jpg" alt="Version sombre du logo GitBook" data-size="line">

Émojis

Vous pouvez ajouter des émojis en appuyant sur / pour ouvrir la palette en ligne. Alternativement, tapez : et une liste d'émojis apparaîtra directement en ligne — vous pouvez commencer à taper le nom d'un émoji pour réduire la sélection.

Représentation en Markdown

:house:
:car:
:dog:

Liens

Vous pouvez insérer trois types de liens différents :

• Liens relatifs

• Liens absolus

• Adresse e-mail mailto liens

Liens relatifs

Les liens relatifs sont des liens créés en faisant un lien vers pages qui existent déjà dans votre espace. L'avantage d'utiliser des liens relatifs est que si l'URL, le nom ou l'emplacement de la page change, sa référence sera tenue à jour — vous aurez donc moins de liens brisés.

Voici comment insérer un lien relatif :

1. Cliquez quelque part dans votre paragraphe à l'endroit où vous souhaitez insérer le lien, ou sélectionnez du texte.

2. Appuyez sur / pour ouvrir la palette en ligne et choisissez Lien, cliquez sur le Lien bouton dans le menu contextuel, ou appuyez sur ⌘ + K.

3. Commencez à taper le titre de la page vers laquelle vous voulez créer le lien.

4. Sélectionnez la page dans les résultats de recherche déroulants.

5. Appuyez sur Entrée.

Liens absolus

Les liens absolus sont des liens externes que vous pouvez copier-coller dans votre contenu. Ils sont utiles lorsque vous souhaitez faire un lien vers quelque chose en dehors de votre documentation.

Pour insérer un lien absolu :

1. Cliquez quelque part dans votre paragraphe à l'endroit où vous souhaitez insérer le lien, ou sélectionnez du texte.

2. Appuyez sur / pour ouvrir la palette en ligne et choisissez Lien, cliquez sur le Lien bouton dans le menu contextuel, ou appuyez sur ⌘ + K.

3. Collez l'URL vers laquelle vous voulez créer le lien.

4. Appuyez sur Entrée.

Pourquoi les liens externes ne s'ouvrent-ils pas dans un nouvel onglet ?

Lorsque vous ajoutez un lien vers un site externe dans vos docs, il s'ouvrira dans le même onglet.

GitBook suit ce comportement recommandé par le W3C pour soutenir l'accessibilité et garantir une expérience cohérente et inclusive pour vos lecteurs.

Liens mailto d'adresse e-mail

Adresse e-mail mailto Les liens sont utiles lorsque vous souhaitez que vos visiteurs cliquent sur un lien qui ouvrira leur client de messagerie par défaut et remplira le Pour le champ avec l'adresse e-mail de votre lien, afin qu'ils puissent rédiger un e-mail à envoyer.

Voici comment insérer un lien d'adresse e-mail mailto :

1. Cliquez quelque part dans votre paragraphe à l'endroit où vous souhaitez insérer le lien, ou sélectionnez du texte.

2. Appuyez sur / pour ouvrir la palette en ligne et choisissez Lien, cliquez sur le Lien bouton dans le menu contextuel, ou appuyez sur ⌘ + K.

3. Collez ou tapez mailto:[e-mail], en remplaçant [e-mail] par l'adresse e-mail que vous souhaitez utiliser.

4. Appuyez sur Entrée.

Représentation en Markdown

[Ceci est un lien relatif vers une autre page dans cet espace](../content-structure/page.md)
[Ceci est un lien absolu](https://www.gitbook.com/blog)
[Ceci est un lien](mailto:[e-mail]) vers notre adresse e-mail de support

Mathématiques & TeX

Avec cette option, vous pouvez créer une formule mathématique en ligne dans votre contenu, comme ceci : $f(x) = x * e^{2 pi i \xi x}$. Nous utilisons la bibliothèque KaTeX pour rendre les formules.

Vous pouvez également insérer une formule mathématique de niveau bloc en ouvrant la palette de commandes dans un bloc vide et en choisissant la deuxième option Math & TeX.

Représentation en Markdown

# Bloc Math et TeX

$$f(x) = x * e^{2 pi i \xi x}$$

Boutons

Les boutons sont un excellent moyen de mettre en valeur des appels à l'action ou d'ajouter une barre de recherche ou "Ask AI" à vos docs. Vous pouvez les utiliser pour envoyer les lecteurs quelque part, ou les aider à trouver des réponses.

Actions des boutons

Les boutons peuvent faire plus que renvoyer vers une URL. Vous pouvez également transformer un bouton en barre de recherche ou en barre GitBook Assistant — directement depuis la page. Ces actions fonctionnent également sur les pages publiées — comme vous pouvez le voir dans les exemples ci-des

Vous pouvez configurer les actions suivantes :

Ajouter un bouton lien

Envoyer les lecteurs vers une autre page ou une URL externe :En savoir plus sur Assistant

Ajouter une barre de recherche

Ouvrir la recherche avec une requête prédéfinie optionnelle :

Ajouter une barre Ask AI/GitBook Assistant

Ouvrir GitBook Assistant avec une invite prédéfinie optionnelle :

Ajouter un bouton désactivé

Afficher un bouton intentionnellement inactif :

Créer et configurer un bouton

1. Tapez / et choisissez Bouton.

2. Cliquez sur le bouton pour ouvrir le Libellé menu.

3. Choisissez une action, puis définissez le libellé et le style.

4. Optionnel : ajoutez une requête de recherche ou une invite Assistant prédéfinie.

Styles

Les boutons lien et inactifs ont des styles primaire et secondaire. Voici quelques exemples :

Inscrivez-vous sur GitBook Aller en haut

Représentation en Markdown

<a href="https://app.gitbook.com" class="button primary">GitBook</a>

Icônes

Les icônes vous permettent d'ajouter des indications visuelles supplémentaires à votre site. Vous pouvez les ajouter en ligne aux paragraphes, à l'intérieur d'une carte, ou partout où vous souhaitez ajouter un peu de style. Elles utiliseront le style visuel défini dans vos paramètres de personnalisation.

Visitez Font Awesome pour explorer les différentes icônes disponibles.

Représentation en Markdown

<i class="fa-github">:github:</i>

Expressions

Les expressions vous permettent d'afficher dynamiquement du contenu défini dans une variable. Les expressions peuvent être insérées depuis le / menu. Une fois insérée, cliquer sur l'expression ouvrira l'éditeur d'expression, vous permettant de référencer et de formater conditionnellement votre variable.