Publier un site de documentation

Publiez votre documentation sur Internet en tant que site de documentation

Une fois que vous avez fini d’écrire, de modifier ou d’importer votre contenu, vous pouvez publier votre travail sur le web sous forme de site de documentation. Vos docs seront publiées sur le web et accessibles au public que vous avez sélectionné.

Le contenu de votre site provient de espaces dans votre organisation. Lorsque vous créez un nouveau site de documentation, vous pouvez créer un nouvel espace ou en lier un existant.

page d’accueil des sites de documentation de GitBook.

Créer un site de documentation

Pour créer un site de documentation, cliquez sur le signe plus + icône à côté de Site de documentation dans la barre latérale pour lancer l’assistant de création de site de documentation.

Donnez un nom à votre site, choisissez un point de départ pour votre contenu et sélectionnez si vous souhaitez publier votre site maintenant ou plus tard.

Si vous avez déjà du contenu dans un espace que vous souhaitez utiliser, vous pouvez créer un site de documentation directement à partir de cet espace en l’ouvrant et en cliquant sur Partager dans le coin supérieur droit de la fenêtre. Puis en choisissant Publier comme site de documentation dans la fenêtre de partage.

Publier un site de documentation

Par défaut, votre site sera publié publiquement. Vous pouvez modifier la visibilité de votre site dans les paramètres du site.

Il existe trois options principales parmi lesquelles choisir lors de la publication de votre site :

Public

Publiez vos docs publiquement sur le web.

Privé avec des liens de partage

Publiez vos docs avec des liens de partage privés.

Accès authentifié

Protégez vos docs publiées derrière une connexion OAuth.

Supprimer ou retirer la publication d’un site de documentation

Pour supprimer un site de documentation, vous devez ouvrir le tableau de bord de votre site, puis ouvrir Paramètres du site dans le coin supérieur droit.

Autorisations du site

Les administrateurs peuvent gérer directement les autorisations du site depuis un site de documentation.

Depuis la page Aperçu du site, cliquez sur Partager dans le coin supérieur droit. Vous pouvez également ouvrir Paramètres > Général et cliquer sur Accès > Gérer les autorisations.

Vous pouvez également gérer ces paramètres depuis Paramètres du site.

Définir un niveau d’autorisation sur un site, pour tout le monde, une équipe ou un utilisateur individuel, détermine leur capacité à administrer ou à consulter le site. Lorsque les espaces au sein du site sont définis sur Hérité mode, ces autorisations sont également propagées à ces espaces.

Le tableau ci-dessous résume comment chaque rôle correspond aux autorisations sur le site et comment cela se propage aux espaces en Hérité mode.

Niveau d’autorisation pour les espaces	Autorisations sur le site
Administrateur	Modifier et voir
Créateur	Voir
Réviseur	Voir
Éditeur	Voir
Commentateur	Voir
Lecteur	Voir
Aucun accès	Ne peut pas voir

Espaces en Hérité mode héritent des autorisations de l’organisation ou de leur collection parente, ainsi que des autorisations du site et de toutes les substitutions locales.

Chaque membre se voit attribuer le rôle le plus élevé qu’il possède parmi ces sources d’autorisations.