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.

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 ».

Dans cet article

Ajout de pages wiki

  1. Dans GitHub.com, accédez à la page principale du dépôt.

  2. Sous le nom de votre référentiel, cliquez sur Wiki.

    Capture d’écran du menu dans un référentiel. L’option « Wiki » est signalée en orange foncé.

  3. Dans le coin supérieur droit de la page, cliquez sur Nouvelle page.

  4. Si vous le souhaitez, pour écrire dans un autre format que le format Markdown, utilisez le menu déroulant « Mode d’édition », puis cliquez sur un autre format.

    Capture d’écran de la page « Créer une page ». La liste déroulante « Mode d’édition » est signalée en orange foncé.

  5. Utilisez l’éditeur de texte pour ajouter le contenu de votre page.

  6. Dans le champ « Modifier le message », entrez un message de validation décrivant le nouveau fichier que vous ajoutez.

  7. Pour commiter les changements apportés au wiki, cliquez sur, Enregistrer la page.

Modification des pages wiki

  1. Dans GitHub.com, accédez à la page principale du dépôt.

  2. Sous le nom de votre référentiel, cliquez sur Wiki.

    Capture d’écran du menu dans un référentiel. L’option « Wiki » est signalée en orange foncé.

  3. À l’aide de la barre latérale du wiki, accédez à la page à changer. Dans le coin supérieur droit de la page, cliquez sur Modifier.

  4. Utilisez l’éditeur de texte pour modifier le contenu de la page.

  5. Dans le champ « Modifier le message », entrez un message de validation décrivant le nouveau fichier que vous ajoutez.

  6. Pour commiter les changements apportés au wiki, cliquez sur, Enregistrer la page.

Ajout ou modification de pages wiki localement

Les wikis font partie des dépôts Git. Vous pouvez donc leur apporter des changements localement, et les pousser vers votre dépôt à l’aide d’un workflow Git.

Clonage de wikis sur votre ordinateur

Le contenu de chaque wiki est clonable facilement sur votre ordinateur. Une fois que vous avez créé une page initiale sur GitHub, vous pouvez cloner le référentiel sur votre ordinateur avec l’URL fournie :

$ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.wiki.git
# Clones the wiki locally

Une fois que vous avez cloné le wiki, vous pouvez ajouter de nouveaux fichiers, modifier des fichiers existants et commiter vos changements. Vous et vos collaborateurs pouvez créer des branches quand vous travaillez sur des wikis. Toutefois, seuls les changements poussés vers la branche par défaut sont mis en production et accessibles à vos lecteurs.

À propos des noms de fichiers wiki

Le nom de fichier détermine le titre de votre page wiki, alors que l’extension de fichier détermine le mode d’affichage du contenu de votre page wiki.

Les wikis utilisent notre bibliothèque de balises open source pour convertir les balises. Ainsi, le convertisseur à utiliser est déterminé en fonction de l’extension d’un fichier. Par exemple, si vous nommez un fichier foo.md ou foo.markdown, le wiki utilise le convertisseur Markdown, alors qu’un fichier nommé foo.textile entraîne l’utilisation du convertisseur Textile.

N’utilisez pas les caractères suivants dans les titres de vos pages wiki : \ / : * ? " < > |. Les utilisateurs de certains systèmes d’exploitation ne peuvent pas utiliser les noms de fichiers contenant ces caractères. Veillez à écrire votre contenu à l’aide d’un langage de balises qui correspond à l’extension, sinon votre contenu ne s’affichera pas correctement.