Chaque dépôt sur GitHub est équipé d’une section pour l’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. 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.
Vous pouvez utiliser Markdown pour ajouter des expressions mathématiques rendues, des diagrammes, des mappages et des modèles 3D à votre wiki. Pour plus d’informations sur la création d’expressions mathématiques rendues, consultez « Écriture d’expressions mathématiques ». Pour plus d’informations sur la création de diagrammes, de mappages et de modèles 3D, consultez « Création de diagrammes ».
Si vous créez un wiki dans un dépôt public, le wiki est disponible pour public. Si vous créez un wiki dans un dépôt privé, seules les personnes 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, 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 modifier les wikis. Toutefois, vous pouvez autoriser tout le monde à contribuer à un wiki dans un dépôt public à partir de sur GitHub.com. Pour plus d’informations, consultez « Changement des autorisations d’accès pour les wikis ».
Note
Les moteurs de recherche indexent uniquement les wikis avec au moins 500 étoiles que vous configurez pour empêcher toute modification publique. Pour plus d’informations, consultez « Changement des autorisations d’accès pour les wikis ».
Si vous avez besoin de moteurs de recherche pour indexer votre contenu, vous pouvez utiliser GitHub Pages dans un dépôt public. Pour plus d’informations, consultez GitHub Pages.
Note
Pour des raisons de performance, les wikis ont une limite souple de 5 000 fichiers au total, quel que soit le type de fichier. Si vous dépassez cette limite, certaines pages pourraient être inaccessibles aux utilisateurs. Si vous avez besoin d’un wiki plus volumineux, nous vous recommandons d’utiliser GitHub Pages. Pour plus d’informations, consultez GitHub Pages.