Skip to main content

Microsoft Word to GitHub Wiki workflow with Writage

Introduction​

This guide explains how to write and edit GitHub wiki pages directly in Microsoft Word using the Writage add-in.

This workflow benefits writers who prefer Word's familiar interface and features while using GitHub for version control and collaboration.

Writage is a Markdown editor add-in for Microsoft Word. It allows users to write and edit Markdown documents directly within Word, making it easier to create and format content for GitHub wikis.

A Markdown document pushed to the wiki repository appears as a new page on the wiki.

Prerequisites​

Instructions​

Setting up Writage​

  1. Follow the installation prompts to set up the Writage add-in.

A graphic showing the Writage installation process

Writage in Microsoft Word​

Once you install the Writage add-in, you can write and edit a Markdown document like a regular Word document. With Writage, you can open existing Markdown files directly in Word, and save Word documents as Markdown files.

A graphic showing the Writage interface in Microsoft Word

Cloning a GitHub wiki to GitHub Desktop​

GitHub Desktop doesn't automatically clone a repository's wiki. You must clone the wiki repository manually.

  1. Open the wiki on GitHub and copy the clone URL from the lower-right corner of the page.

    A screenshot of this wiki's homepage

  2. In GitHub Desktop, press Ctrl+Shift+O to open the Clone a repository dialog.

  3. Click the URL tab.

  4. Paste the wiki URL, then click Clone.

    A screenshot of a cloning dialog in GitHub Desktop

Pushing a Markdown document to a GitHub wiki​

After writing a Markdown document in Word, you can push it directly to your GitHub wiki repository. This eliminates the need to copy, paste, and format content in GitHub's web editor.

  1. Save the Markdown document into the local directory where you cloned the wiki repository.

  2. Open the GitHub Desktop app.

  3. Select the wiki repository.

  4. Enter a concise commit summary, then click Commit to main or Commit to master.

    note

    The summary describes the document updates, helping other contributors understand revisions without reading the entire file.

    A screenshot of the commit dialog in GitHub Desktop

  5. Press Ctrl+P or click Push origin to push the changes to the wiki.

  6. Open the wiki in a web browser to verify the published page.

Repeat these steps whenever you create a new document or edit an existing wiki page.

Converting a Markdown document into a PDF file​

  1. Open the Markdown document in Word.
  2. Click File > Save As.
  3. Select PDF in the file format dropdown menu.
  4. Choose a destination folder, then click Save.