Contenu en ligne

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

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 des mains. Il suffit d’appuyer sur / dans n’importe quel bloc de texte pour ouvrir la palette en ligne. Le slash sera remplacé par le contenu que vous choisissez d’insérer.

Annotations

Avec les annotations, vous pouvez ajouter du 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 votre annotation rédigée, cliquez à l’extérieur 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 en 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 apparaîtront à côté de votre texte sur la page.

Par défaut, les images conservent 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 mise en forme, puis en choisissant l’une des trois options :

1. Taille en ligne : L’image est dimensionnée proportionnellement à la police — idéal pour les icônes et les badges.

2. Taille d’origine : 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 image, qui occupe toute la largeur de votre contenu.

Les blocs d’image offrent davantage d’options, notamment plus 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="Dark version of GitBook logo" data-size="line">

Émojis

Vous pouvez ajouter des émojis en appuyant sur / pour ouvrir la palette en ligne. Vous pouvez aussi taper : et une liste d’émojis apparaîtra directement en ligne — vous pouvez commencer à taper le nom d’un émoji pour affiner 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 pointant vers pages qui existent déjà dans votre espace. L’avantage des liens relatifs est que si l’URL, le nom ou l’emplacement de la page change, sa référence restera à jour — vous aurez donc moins de liens cassés.

Voici comment insérer un lien relatif :

1. Cliquez à un endroit de votre paragraphe 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 souhaitez créer un lien.

4. Sélectionnez la page dans les résultats de recherche du menu déroulant.

5. Appuyez sur Entrée.

Liens absolus

Les liens absolus sont des liens externes que vous pouvez copier et coller dans votre contenu. Ils sont parfaits lorsque vous souhaitez créer un lien vers quelque chose en dehors de votre documentation.

Pour insérer un lien absolu :

1. Cliquez à un endroit de votre paragraphe 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 souhaitez créer un 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 votre documentation, il s’ouvrira dans le même onglet.

GitBook suit ce comportement recommandé par le W3C afin de soutenir l’accessibilité et d’assurer une expérience cohérente et inclusive à vos lecteurs.

Les liens mailto d’adresse e-mail

Adresse e-mail mailto sont utiles lorsque vous souhaitez que vos visiteurs cliquent sur un lien qui ouvrira leur client de messagerie par défaut et remplira 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 mailto lien d’adresse e-mail :

1. Cliquez à un endroit de votre paragraphe 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 d’assistance

Math & 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 KaTeX bibliothèque pour rendre les formules.

Vous pouvez aussi 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 avant des appels à l’action ou d’ajouter une barre de recherche ou Ask AI à votre documentation. Vous pouvez les utiliser pour diriger 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 aussi transformer un bouton en barre de recherche ou en barre GitBook Assistant — directement depuis la page. Ces actions fonctionnent aussi sur les pages publiées, comme vous pouvez le voir dans les exemples ci-dessous

Vous pouvez configurer les actions suivantes :

Ajouter un bouton de lien

Diriger 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 facultative :

Ajouter une barre Ask AI/GitBook Assistant

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

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 menu Libellé .

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

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

Styles

Les boutons de lien et les boutons inactifs disposent tous deux de styles principal et secondaire. Voici quelques exemples :

Inscrivez-vous à 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 dans des paragraphes, à l’intérieur d’une carte, ou partout ailleurs 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, un clic sur l’expression fera apparaître l’éditeur d’expression, vous permettant de faire référence à votre variable et de la mettre en forme conditionnellement .