Wikis are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see "GitHub's products."

You can add images and links to content in your wiki, and use some supported MediaWiki formats.

In this guide

Adding links

You can create links in wikis using the standard markup supported by your page, or using MediaWiki syntax. For example:

  • If your pages are rendered with Markdown, the link syntax is [Link Text](full-URL-of-wiki-page).
  • With MediaWiki syntax, the link syntax is [[Link Text|nameofwikipage]].

Adding images

Wikis can display PNG, JPEG, and GIF images.

  1. On GitHub, navigate to the main page of the repository.

  2. Under your repository name, click Wiki. Wiki menu link

  3. Using the wiki sidebar, navigate to the page you want to change, and then click Edit.

  4. On the wiki toolbar, click Image. Wiki Add image button
  5. In the "Insert Image" dialog box, type the image URL and the alt text (which is used by search engines and screen readers).
  6. Click OK.

Linking to images in a repository

You can link to an image in a repository on GitHub by copying the URL in your browser and using that as the path to the image. For example, embedding an image in your wiki using Markdown might look like this:

[[https://github.com/username/repository/blob/master/img/octocat.png|alt=octocat]]

Supported MediaWiki formats

No matter which markup language your wiki page is written in, certain MediaWiki syntax will always be available to you.

  • Links (except Asciidoc)
  • Horizontal rules via ---
  • Shorthand symbol entities (such as δ or €)

For security and performance reasons, some syntaxes are unsupported.

  • Transclusion
  • Definition lists
  • Indentation
  • Table of contents