Contenu en ligne

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

A GitBook screenshot showing inline content options
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 retirer les mains du clavier. Appuyez simplement sur / sur n'importe quel bloc de texte pour ouvrir la palette en ligne. Le slash avant sera remplacé par le contenu que vous choisissez d'insérer.

Annotations

Avec les annotations, vous pouvez ajouter un contexte supplémentaire à vos mots sans perturber la concentration 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 le contenu en tant que notes de bas de page Markdown pour les ajouter sous forme d'annotations dans GitBook.

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

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

[^bignote] : 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 affichées aux côtés de votre texte sur la page.

Par défaut, les images sont réglées à leur taille d'origine avec une largeur maximale de 300px. Vous pouvez changer 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 proportionnellement dimensionnée par rapport à la police — idéale 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 bloc d'image, qui est aussi large que votre contenu.

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

Émojis

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

Liens

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

Liens relatifs

Les liens relatifs sont créés en liant à 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 mise à jour — ce qui vous évitera d'avoir trop de liens cassés.

Voici comment insérer un lien relatif :

  1. Cliquez quelque part dans votre paragraphe où vous souhaitez insérer le lien, ou sélectionnez un texte.

  2. Appuyez sur / pour ouvrir la palette en ligne et choisir 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 déroulants.

  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 idéaux lorsque vous souhaitez créer un lien vers quelque chose en dehors de votre documentation.

Pour insérer un lien absolu :

  1. Cliquez quelque part dans votre paragraphe où vous souhaitez insérer le lien, ou sélectionnez un texte.

  2. Appuyez sur / pour ouvrir la palette en ligne et choisir 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 vos documents, il s'ouvrira dans le même onglet.

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

Liens mailto d'adresse e-mail

Adresse e-mail mailto 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 champ À avec l'adresse e-mail de votre lien, afin qu'ils puissent rédiger un e-mail à envoyer.

Voici comment insérer une adresse e-mail mailto lien :

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

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

  3. Collez ou tapez mailto:something@address.com, en remplaçant something@address.com par l'adresse e-mail que vous souhaitez utiliser.

  4. Appuyez sur Entrée.

Maths & TeX

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

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

Boutons

Les boutons sont un excellent moyen de décrire des appels à l'action. Vous pouvez les utiliser pour envoyer les utilisateurs vers d'autres pages dans GitBook, ou vers des URL externes.

Les boutons ont à la fois des styles primaires et secondaires. Voici quelques exemples :

Sign up to GitBook Go to top

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 où vous avez besoin d'ajouter une touche 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.

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 double-clic sur l'expression ouvrira l'éditeur d'expressions, vous permettant de référencer et de formater conditionnellement votre variable.

Mis à jour

Ce contenu vous a-t-il été utile ?