-
Notifications
You must be signed in to change notification settings - Fork 5
WikiMaintenance
This page describes how to add images and other kinds of files to a GitHub Wiki.
The original sources of this page can be found here. We adapted them to our conventions.
Any GitHub wiki can be cloned by appending wiki.git to the repo url,
so the clone url for the repo
https://github.com/uni-bremen-agst/SEE/ is:
git@github.com:uni-bremen-agst/SEE.wiki.git (for ssh) or
https://github.com/uni-bremen-agst/SEE/wiki.git (for https).
You make edits, and commit and push your changes, like any normal
repo. This wiki repo is distinct from any clone of the project repo
(the repo without wiki.get appended).
You need to clone the wiki repo and edit it on your system.
Add images to the images directory (or subdirectory below it) in the
wiki repo. For example: images/overview.png.
In your wiki page markup, embed an image link in the following format:
[[/images/overview.png|ALT TEXT]]
Note the leading / in the path. You don't need it if all your wiki
docs and image files are located at the top level of the wiki (like
when you use the online wiki editor), but if you are working with a
clone of the wiki, then you can organize files in subdirectories; and
in that case, absolute or relative path specifiers are critical so
that the path to the image resolves correctly when editing a doc that
is located in a different subdirectory.
Commit and push your changes.
This is not the same as providing a link to an image that is part of your project repo (not the wiki repo). If you want to link to an image in your project repo, you will need a full URL that looks something like this:
[[https://github.com/username/repository/blob/master/img/octocat.png|alt=octocat]]
See references, below.
Follow the instructions described in the previous section. However,
use the directory literature instead.
In your wiki page markup, embed an image link in the following format:
[Text describing the PDF](literature/myfile.pdf "Text describing the PDF")
You need to clone the wiki repo and edit it on your system.
Add files to the files directory (or subdirectory below it). For example: files/project-presentation.pptx`.
In your wiki page markup, add the file link in the following format:
[link text](files/path/to/file "ALT TEXT")
For example:
[Project Presentation](files/project-presentation..pptx "Project Presentation in Powerpoint")
Commit and push your changes.