Skip to main content

Microsoft Word to GitHub wiki workflow with Writage

Introduction​

This guide explains how to write and edit GitHub wiki pages in Microsoft Word with the Writage add-in. Use this workflow when you prefer Word's editing tools and want GitHub to track every revision of a page.

Writage adds Markdown support to Microsoft Word. You can open, edit, and save Markdown files inside Word. Each Markdown file you push to the wiki repository becomes a page on the wiki, and the filename sets the page name.

Prerequisites​

Instructions​

note

The steps use Windows shortcuts. On macOS, press Cmd where the steps say Ctrl.

Setting up Writage​

  1. Run the Writage installer and follow the prompts.

    Writage installer with the default installation options

  2. Open Microsoft Word and confirm the Writage tab appears on the ribbon.

Writage in Microsoft Word​

Once you install the add-in, Word treats Markdown files like any other document. You can open an existing Markdown file, or create a new one.

  1. Select File > Save As.
  2. Select Markdown in the file format list.
  3. Name the file after the wiki page you want to create.

Writage tab on the Word ribbon with Markdown styles

Cloning a GitHub wiki to GitHub Desktop​

GitHub Desktop doesn't clone wikis with the repository. Clone the wiki yourself.

  1. Open the wiki in your browser, then copy the address from the Clone this wiki locally section.

    GitHub wiki page with the wiki clone address

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

  3. Paste the wiki address, then select Clone.

    GitHub Desktop Clone a repository dialog with the address field

Pushing a Markdown document to a GitHub wiki​

Push the file to the wiki repository. You skip GitHub's web editor, so you never copy and reformat the page.

  1. Save the Markdown file into the local folder where you cloned the wiki repository.

  2. Open GitHub Desktop and select the wiki repository.

  3. Enter a concise commit summary, then select Commit to main. If the wiki uses a different default branch, the button shows that branch name.

    note

    Write a summary that explains the change, so others don't need to open the file.

    GitHub Desktop commit summary field and commit button

  4. Press Ctrl+P, or select Push origin, to push the changes.

  5. Open the wiki in your browser to verify the new page.

Repeat these steps for each new document or each edit to an existing page.

Converting a Markdown document into a PDF file​

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