GitBook est une plateforme qui vous permet, à vous et à votre équipe, de créer et de collaborer sur des sites de documentation. GitBook le fait en utilisant des concepts de contrôle de version, tels que la création de branches et la fusion.
Étant donné que de nombreux membres de l'équipe peuvent travailler sur un seul site de documentation, GitBook vous permet de créer et de gérer des brouillons distincts. Vous pouvez également afficher les différences entre votre brouillon actuel et la copie de la documentation principale.
Plusieurs types de blocs sont disponibles pour que vous puissiez les ajouter à vos pages wiki. Cela inclut les titres, les paragraphes, les images, les conseils, les tableaux, les blocs de code, les pièces jointes, etc.
Comment ajouter des blocs de contenu dans GitBook
Vous pouvez afficher une liste des blocs de contenu disponibles à ajouter à une page. Vous pouvez le faire en cliquant n'importe où sur la page et en cliquant sur le plus symbole qui apparaît. Vous pouvez également rechercher directement un bloc de contenu spécifique.
Vous pouvez ajouter du contenu à l'aide de Markdown. Si vous n'avez jamais utilisé Markdown auparavant, vous pouvez en savoir plus sur comment démarrer avec Markdown. Vous pouvez également en savoir plus sur pourquoi Markdown est si populaire.
Comment ajouter des paragraphes, des listes, des citations ou des blocs de code
Pour ajouter des listes, des paragraphes, des citations, des blocs de code ou d'autres blocs de contenu simples, ouvrez la liste déroulante et sélectionnez parmi les types disponibles.
- Sur une page de votre site de documentation, cliquez sur le plus bouton à l'endroit où vous souhaitez ajouter votre contenu.
- Dans la liste déroulante, vous pouvez faire défiler la liste pour afficher les différentes options de contenu.
- À partir de là, sélectionnez n'importe quel type de contenu simple, tel qu'un paragraphe, un bloc de code, un titre ou une citation. GitBook modifiera automatiquement le contenu pour correspondre au format que vous avez sélectionné.
Comment ajouter des images ou des pièces jointes
Pour ajouter des images, utilisez la liste déroulante pour sélectionner le Images option de bloc de contenu. Pour ajouter des fichiers, sélectionnez le Insérer des fichiers à la place. Vous pouvez ensuite utiliser le panneau de droite pour gérer vos images et fichiers téléchargés.
- Ouvrez une page sur votre site de documentation. Clique sur le plus pour ouvrir la liste déroulante des blocs de contenu disponibles.
- Sélectionner Insérer des images.
- Dans le panneau de droite qui apparaît, il y a trois onglets. La Des dossiers L'onglet vous permet de télécharger votre propre fichier image. La URL L'onglet vous permet de créer un lien vers une image en ligne. Vous pouvez également ouvrir le Unsplash languette. C'est ici que vous pouvez sélectionner des photos existantes qui ne nécessitent pas d'attribution.
- Une fois que vous avez ajouté une image, cliquez sur le trois points bouton situé dans le coin supérieur gauche de l'image. Cela ouvrira une liste déroulante où vous pourrez aligner l'image ou la supprimer. Vous pouvez également donner une légende à l'image.
- Pour insérer des fichiers, placez votre curseur n'importe où sur une page de votre site de documentation. Clique sur le plus bouton pour ouvrir la liste déroulante des types de bloc de contenu. Cette fois, cliquez sur le insérer des fichiers option.
- Un panneau de droite similaire apparaîtra, vous permettant de télécharger n'importe quelle pièce jointe au lieu d'une image. Cliquer sur Parcourir les fichiers pour sélectionner un fichier stocké localement sur votre ordinateur.
- Le fichier apparaîtra dans la liste. Cliquez sur le fichier et GitBook créera un bloc de contenu avec la pièce jointe sur la page que vous avez ouverte. Cliquer sur ce bloc de contenu téléchargera le fichier joint.
Comment ajouter des conseils
Vous pouvez également ajouter des indices à votre page. Vous pouvez modifier l'icône des indices pour qu'ils utilisent le rouge pour le danger, l'orange pour l'avertissement, le bleu pour l'information ou le vert pour le succès.
- Pour ajouter un indice, cliquez sur le plus pour ouvrir la liste déroulante des blocs de contenu disponibles.
- Sélectionner Indice.
- Cela ajoutera un indice à votre page. Par défaut, le type d'indice est "information" et contient une icône bleue.
- Vous pouvez modifier le type d'indice en cliquant sur l'icône. Cela parcourra les quatre types d'indices différents.
Comment ajouter des tableaux
Vous pouvez ajouter des tableaux en sélectionnant le table option dans la liste déroulante. Une fois que vous avez le tableau sur la page, vous pouvez ajouter de nouvelles lignes ou colonnes. Vous pouvez également modifier les noms et les types de données des colonnes et modifier les données à l'intérieur de la table.
- Clique sur le plus pour ouvrir la liste déroulante des blocs de contenu disponibles.
- Sélectionner Table.
- Cliquez sur l'en-tête d'une colonne du tableau. Cela ouvrira un nouveau menu plus petit, où vous pourrez changer le nom de la colonne sélectionnée. Ce menu vous permet également de supprimer ou de masquer la colonne sélectionnée. Pour certains types de données de colonne, vous pouvez également aligner le contenu à l'intérieur de la colonne.
- Par défaut, le type de données sélectionné pour les colonnes est "Texte". Cliquez sur le bouton avec le J symbole pour changer le type de données. Vous pouvez le changer en un nombre, une case à cocher, une liste déroulante, une pièce jointe, une note ou plus.
- Clique sur le icône à six points près du coin supérieur gauche du tableau. Ici, vous pouvez insérer de nouvelles colonnes et lignes ou supprimer le tableau entier. Vous pouvez également masquer ou afficher certaines colonnes, ou modifier d'autres propriétés du tableau.
Comment ajouter des blocs de liens de page
Les blocs de liens de page sont des liens qui occupent toute la ligne sur la page. Lorsque vous ajoutez le lien, vous devez créer un lien vers la page qui s'ouvrira lorsque quelqu'un cliquera dessus.
- Clique sur le plus pour ouvrir la liste déroulante des blocs de contenu disponibles.
- Cliquer sur Lien vers la page.
- Dans la nouvelle liste déroulante, choisissez la page vers laquelle vous créez un lien.
- Le lien de votre page apparaîtra dans un bloc sur la page.
Utilisation de GitBook pour la documentation
GitBook est un outil de documentation qui utilise des concepts de contrôle de version tels que la création de branches et la fusion. Cela permet à plusieurs membres de l'équipe de travailler simultanément sur la documentation. Cela aide également à gérer les conflits qui surviennent.
Vous pouvez ajouter toutes sortes de blocs de contenu à une page. Vous pouvez utiliser des titres, des paragraphes, des blocs de code ou des puces pour reformater votre contenu. Vous pouvez modifier le type d'astuce, le message et le type d'icône des astuces, ainsi que personnaliser les colonnes d'un tableau.
L'onglet Fichiers vous permet de gérer les images et les pièces jointes que vous téléchargez sur le site. Les liens de page vous permettent de créer des liens volumineux que les utilisateurs peuvent facilement repérer.
Si vous créez de la documentation liée au langage Go, vous pouvez utiliser Godoc. Godoc vous permet de documenter automatiquement votre code Go.
