Embedding images inside a GitHub wiki (gollum) repository?

Question

The Github wikis are backed by a separate git repository then the main project repository.

This post by the Github team makes it sound like you should be able to link to images stored in the wiki repository inside the wiki markup.

Images and Folders

You can now reference images hosted inside the Git repository.

I've checked out my wiki's repository and pushed a resource folder and an image into it. My question is, how do I go about using this image?

Is this even possible or have I misunderstood something?

Answer 1

For viewers wishing to view images on a github wiki I've found the following method to work:

• Go to the "Git Access" tab inside the wiki page of your repository and retrieve the SSH path which should be some thing like: [email protected]:USER/REPO.wiki.git where USER is your account name and REPO is the repository name.

• On your local machine use whichever Git command line tool you wish to cd into your local directory of choice and get the repository via

  git clone [email protected]:USER/REPO.wiki.git

• Now within this repository create an image directory, I'll call it "images" and put whatever images you want into the directory

• And then push your wiki git directory to github

• You will not be able to physically see the images in say the "Pages" tab, but if you simply reference the images in a local link you should be able to see them. Example with Markdown below:

  ![Alt attribute text Here](images/YOURIMAGE.ext)

• You may also embed the image as a link itself by wrapping it further like so:

  [![Alt attribute text Here](images/YOURIMAGE.ext)](http://Yoursite.com)

You can also add subdirectories within your local copy to help organize the wiki since the "pages" tab simply lists them out. Keep in mind, however, that even when the new directory is pushed the "pages" tab doesn't list the directory.

Answer 2

To use relative paths do:

[[foo.jpg]] 

For more info, see the demo wiki's page on images.