Publier un site de documentation

Publiez votre documentation sur Internet sous forme de site de documentation

Lorsque vous avez terminé de rédiger, modifier ou importer votre contenu, publiez-le pour l’audience que vous avez sélectionnée.

Le contenu d’un site de documentation se trouve dans son sections. La structure que vous modifiez est celle que les visiteurs obtiennent. Les nouvelles sections commencent comme des brouillons, afin que vous contrôliez ce qui apparaît sur votre site publié.

Accueil de votre organisation.

Créer un site de documentation

Pour créer un site de documentation :

1. Depuis votre organisation Accueil, cliquez sur le + icône à côté de Sites.
2. Saisissez un nom que les visiteurs reconnaîtront.
3. Cliquez sur Créer.
4. Choisissez un point de départ : un modèle de documentation, une importation, une spécification OpenAPI, une section vide ou Git Sync.

Pour un guide d’installation complet, consultez le Démarrage rapide.

Vous pouvez gérer les autorisations du site dans Paramètres → Membres. Cela vous permet de contrôler qui peut consulter ou modifier chaque site indépendamment des paramètres de l’organisation. Voir Rôles pour plus de détails.

Publier un site de documentation

Pour publier votre site :

1. Depuis votre organisation Accueil, ouvrez votre site.
2. Cliquez sur Publier dans l’en-tête du site.

Les sites sont publics par défaut. Modifiez la visibilité de votre site dans Paramètres → Audience. Voir Paramètres du site.

Choisissez l’une de ces options d’audience :

Public

Publiez vos documents publiquement sur le web.

Privé avec des liens de partage

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

Accès authentifié

Protégez vos documents publiés derrière une connexion OAuth.

Prévisualiser votre site

Cliquez sur Aperçu dans l’en-tête du site pour voir votre contenu tel que les visiteurs le verront — avant de publier le site, ou pendant que vous travaillez sur les modifications. Vérifiez votre contenu et vos personnalisations, puis publiez lorsque tout vous semble correct.

Supprimer ou dépublier un site de documentation

Pour dépublier votre site, ouvrez Paramètres → Général et sélectionnez Dépublier le site. Une fois confirmé, le site n’est plus accessible aux visiteurs.

La dépublication ne modifie pas votre facturation. Pour ajuster le nombre de sites que vous payez, mettez à jour votre forfait dans les paramètres de facturation de votre organisation.

Mon site est toujours accessible après dépublication ou suppression

Si vous pouvez toujours ouvrir l’URL, l’ancienne version est généralement mise en cache — dans votre navigateur, sur un CDN ou dans un résultat de moteur de recherche. Pour confirmer que le site n’est plus en ligne, ouvrez l’URL dans une fenêtre privée, ou videz le cache de votre navigateur pour ce site et rechargez la page.

Mon site apparaît toujours dans les moteurs de recherche

Les moteurs de recherche mettent du temps à mettre à jour leurs index, donc un site dépublié peut apparaître dans les résultats pendant un certain temps. La durée dépend de facteurs tels que la fréquence d’exploration et le nombre d’autres sites qui renvoient vers la page.

Pour accélérer les choses, demandez un nouveau crawl dans Google Search Console : ouvrez l’ Inspection d’URL onglet, saisissez l’URL, puis cliquez sur Demander l’indexation. Google examine la demande et supprime la page de son index si elle n’est plus publiée.

Vous pouvez vérifier si votre site est toujours indexé en recherchant dans Google site: suivi de l’URL de votre site.

Pour supprimer un site de documentation :

1. Ouvrez Paramètres → Général.
2. Sélectionnez Supprimer le site.

La suppression d’un site retire définitivement ses paramètres et ses personnalisations. Votre contenu reste dans votre organisation — retrouvez-le dans Tout le contenu.