Skip to main content

Documentation de votre projet avec des wikis

Vous pouvez utiliser un wiki pour partager des informations détaillées sur votre projet.

Qui peut utiliser cette fonctionnalité ?

Les wikis sont disponibles dans les référentiels publics avec GitHub Free et GitHub Free pour les organisations, et dans les référentiels publics et privés avec GitHub Pro, GitHub Team, GitHub Enterprise Cloud et GitHub Enterprise Server. Pour plus d’informations, consultez « Plans de GitHub ».

À propos des wikis

Vous pouvez héberger la documentation de votre dépôt dans un wiki, afin que d’autres personnes puissent utiliser et contribuer à votre projet.

Ajout ou modification de pages wiki

Vous pouvez ajouter et modifier des pages wiki directement sur GitHub, ou localement à l’aide de la ligne de commande.

Création d’un pied de page ou d’une barre latérale pour votre wiki

Vous pouvez ajouter une barre latérale ou un pied de page personnalisés à votre wiki pour fournir aux lecteurs des informations expliquant davantage le contexte.

Modification du contenu d’un wiki

Vous pouvez ajouter des images et des liens vers des contenus dans votre wiki, et utiliser certains formats MediaWiki pris en charge.

Affichage de l’historique des changements apportés à un wiki

Étant donné que les wikis sont des dépôts Git, chaque modification que vous apportez est un commit que vous pouvez afficher.

Changement des autorisations d’accès pour les wikis

Seuls les collaborateurs de dépôt peuvent modifier le wiki d’un dépôt public par défaut. Toutefois, vous pouvez autoriser toute personne disposant d’un compte sur GitHub.com à modifier votre wiki.

Désactivation des wikis

Vous pouvez désactiver le wiki de votre dépôt.