Chaque dépôt sur GitHub AE comporte une section d’hébergement de la documentation, appelée wiki. Vous pouvez utiliser le wiki de votre dépôt afin de partager du contenu détaillé sur votre projet, par exemple pour décrire son utilisation, sa conception ou ses principes de base. Un fichier README décrit rapidement votre projet, alors qu’un wiki vous permet de fournir de la documentation supplémentaire. Pour plus d’informations, consultez « À propos des README ».
Avec les wikis, vous pouvez écrire du contenu comme vous pouvez le faire partout ailleurs sur GitHub AE. Pour plus d’informations, consultez « Prise en main de la rédaction et de la mise en forme sur GitHub ». Nous utilisons notre bibliothèque de balises open source pour convertir différents formats en HTML. Vous pouvez donc choisir d’écrire en Markdown ou dans tout autre format pris en charge.
Si vous créez un wiki dans un dépôt privé, seules les membres de l’entreprise ayant accès au dépôt peuvent consulter le wiki. Pour plus d’informations, consultez « Définition de la visibilité du dépôt ».
Vous pouvez modifier des wikis directement sur GitHub AE, ou vous pouvez modifier des fichiers wiki localement. Par défaut, seules les personnes disposant d’un accès en écriture à votre dépôt peuvent apporter des changements aux wikis. Toutefois, vous pouvez autoriser tout le monde sur votre entreprise à contribuer à un wiki dans un dépôt interne. Pour plus d’informations, consultez « Changement des autorisations d’accès pour les wikis ».
Remarque : Les moteurs de recherche n’indexent pas le contenu des wikis. Pour que votre contenu soit indexé par les moteurs de recherche, vous pouvez utiliser GitHub Pages dans un dépôt public.