Aller au contenu principal

Workflow de Microsoft Word vers un wiki GitHub avec Writage

Introduction​

Ce guide explique comment rédiger et éditer des pages wiki GitHub dans Microsoft Word à l'aide du complément Writage. Utilisez ce workflow si vous préférez les outils d'édition de Word et souhaitez que GitHub suive chaque révision d'une page.

Writage ajoute la prise en charge de Markdown à Microsoft Word. Vous pouvez ouvrir, éditer et enregistrer des fichiers Markdown dans Word. Chaque fichier Markdown poussé vers le dépôt wiki devient une page du wiki, et le nom du fichier définit le nom de la page.

Prérequis​

Instructions​

Remarque

Les étapes utilisent les raccourcis Windows. Sur macOS, appuyez sur Cmd là où les étapes indiquent Ctrl.

Configuration de Writage​

  1. Lancez le programme d'installation de Writage et suivez les invites.

    Programme d'installation de Writage avec les options par défaut

  2. Ouvrez Microsoft Word et vérifiez que l'onglet Writage apparaît dans le ruban.

Writage dans Microsoft Word​

Une fois le complément installé, Word traite les fichiers Markdown comme n'importe quel autre document. Vous pouvez ouvrir un fichier Markdown existant ou en créer un nouveau.

  1. Sélectionnez Fichier > Enregistrer sous.
  2. Sélectionnez Markdown dans la liste des formats de fichier.
  3. Nommez le fichier d'après la page wiki à créer.

Onglet Writage dans le ruban Word avec les styles Markdown

Cloner un wiki GitHub dans GitHub Desktop​

GitHub Desktop ne clone pas les wikis avec le dépôt. Clonez le wiki vous-même.

  1. Ouvrez le wiki dans votre navigateur, puis copiez l'adresse de la section Cloner ce wiki localement.

    Page wiki GitHub avec l'adresse de clonage du wiki

  2. Dans GitHub Desktop, appuyez sur Ctrl+Maj+O pour ouvrir la boîte de dialogue Clone a repository.

  3. Collez l'adresse du wiki, puis sélectionnez Clone.

    Boîte de dialogue Clone a repository de GitHub Desktop avec le champ d'adresse

Pousser un document Markdown vers un wiki GitHub​

Poussez le fichier vers le dépôt wiki. Vous évitez ainsi l'éditeur web de GitHub et ne recopiez ni ne reformatez la page.

  1. Enregistrez le fichier Markdown dans le dossier local où vous avez cloné le dépôt wiki.

  2. Ouvrez GitHub Desktop et sélectionnez le dépôt wiki.

  3. Saisissez un résumé de commit concis, puis sélectionnez Commit to main. Si le wiki utilise une autre branche par défaut, le bouton affiche le nom de cette branche.

    Remarque

    Rédigez un résumé qui explique la modification, pour que les autres n'aient pas besoin d'ouvrir le fichier.

    Champ de résumé de commit et bouton de validation dans GitHub Desktop

  4. Appuyez sur Ctrl+P, ou sélectionnez Push origin, pour pousser les modifications.

  5. Ouvrez le wiki dans votre navigateur pour vérifier la nouvelle page.

Répétez ces étapes pour chaque nouveau document ou chaque modification d'une page existante.

Conversion d'un document Markdown en fichier PDF​

  1. Ouvrez le document Markdown dans Word.
  2. Sélectionnez Fichier > Enregistrer sous.
  3. Sélectionnez PDF dans la liste des formats de fichier.
  4. Choisissez un dossier de destination, puis sélectionnez Enregistrer.