Aller au contenu principal

Workflow Microsoft Word vers GitHub Wiki avec Writage

Introduction​

Ce guide explique comment utiliser le complément Writage pour Microsoft Word afin d'écrire et d'éditer des pages wiki GitHub directement à partir de Word.

Cela peut être bénéfique pour les rédacteurs qui préfèrent l'interface et les fonctionnalités familières de Word, tout en étant en mesure d'exploiter les capacités de contrôle de version et de collaboration de GitHub.

Writage est un complément d'édition Markdown pour Microsoft Word. Il permet aux utilisateurs d'écrire et d'éditer des documents Markdown directement dans Word, ce qui facilite la création et la mise en forme de contenu pour les wikis GitHub.

Un document Markdown transféré dans le référentiel wiki apparaîtra comme une nouvelle page sur le wiki.

Prérequis​

Instructions​

Mise en place de Writage​

  1. Suivez les instructions d'installation pour configurer le complément Writage.

Un graphique montrant le processus d'installation de Writage

Writage dans Microsoft Word​

Une fois que vous avez installé le complément Writage, vous pouvez écrire et éditer un document Markdown comme un document Word normal. Avec Writage, vous pouvez ouvrir des fichiers Markdown existants directement dans Word et enregistrer des documents Word en tant que fichiers Markdown

Un graphique montrant l'interface de Writage dans Microsoft Word

Convertir un document Markdown en fichier PDF​

  1. Ouvrez le document Markdown dans Word.
  2. Cliquez sur Fichier > Enregistrer sous.
  3. Sélectionnez PDF dans le menu déroulant du type de fichier.
  4. Enregistrer le fichier à l'emplacement choisi.

Cloner un wiki GitHub sur GitHub Desktop​

GitHub Desktop ne clone pas automatiquement un wiki GitHub. Vous devrez le cloner manuellement.

  1. Ouvrez le wiki et copiez l'URL dans le coin inférieur droit de la page.

    Une capture d'écran de la page d'accueil de ce wiki

  2. Dans GitHub Desktop, appuyez sur CTRL+SHIFT+O pour ouvrir la boîte de dialogue "Cloner un dépôt".

  3. Cliquer sur l'onglet URL.

  4. Collez l'URL du wiki et appuyez sur Clone.

Capture d'écran d'une boîte de dialogue de clonage dans GitHub Desktop

Pousser un document Markdown vers un Wiki GitHub​

Une fois que vous avez écrit un document Markdown dans Word, vous pouvez le pousser vers le wiki du dépôt GitHub sans avoir à le copier et le coller dans l'éditeur Markdown de GitHub et à le formater là-bas.

  1. Enregistrez le document Markdown dans le dossier wiki défini lors de l'installation de GitHub Desktop.
  2. Ouvrez l'application GitHub Desktop.
  3. Sélectionnez le dépôt wiki.
  4. Validez les modifications (ajoutez un résumé).
  5. Appuyez sur CTRL+P pour transférer les modifications sur le wiki.
remarque

Ajoutez un résumé au fichier avant qu'il ne soit transféré sur le wiki. Le résumé décrit brièvement les modifications apportées au document, ce qui aide les autres contributeurs à comprendre les mises à jour sans avoir à lire l'intégralité du document.

Une capture d'écran de la boîte de dialogue de validation dans GitHub Desktop

  1. Ouvrez le wiki dans un navigateur pour vérifier la mise à jour du wiki.

Répétez les étapes pour pousser le document vers GitHub lors de la création d'un nouveau document ou de la modification d'un document existant.