Skip to content

Useful stuff to know about the Wiki

Jump to bottom
Andy Berry edited this page Oct 31, 2013 · 2 revisions

Markdown Syntax

There are several useful pages on GitHub markdown syntax.

Image attachments

Unfortunately github doesn't presently have a great solution for this. However, since github wikis are just repos you can add images to the repo and then reference them.

Clone a github wiki

The git URL for the wiki for your repo is very similar to the one for your actual repo. In fact, it just has a .wiki before the trailing .git e.g.

[email protected]:BladeRunnerJS/brjs.git

becomes

[email protected]:BladeRunnerJS/brjs.wiki.git

So, you can clone the wiki repo as normal:

git clone [email protected]:BladeRunnerJS/brjs.wiki.git
cd brjs.wiki

And then add any images you want e.g.

mkdir img
cp path/to/some/images/* img/

Then add, commit and push

git add img
git commit -m 'some commit message'
git push origin master

You can now reference the images via the relative path from the wiki document you are editing e.g. if I were editing the standard Home.md I could now reference an image named example.png in the new img directory as follows:

# Wiki Home Page

[[img/example.png]]
Clone this wiki locally