1
0
mirror of synced 2025-12-23 21:07:12 -05:00
Files
docs/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md
2023-11-30 18:10:09 +00:00

2.7 KiB

title, intro, redirect_from, product, versions, topics
title intro redirect_from product versions topics
Editing wiki content You can add images and links to content in your wiki, and use some supported MediaWiki formats.
/articles/adding-links-to-wikis
/articles/how-do-i-add-links-to-my-wiki
/articles/how-do-i-add-or-upload-images-to-the-wiki
/articles/needs-writing-review-how-do-i-add-or-upload-images-to-the-wiki
/articles/how-do-i-add-images-to-my-wiki
/articles/adding-images-to-wikis
/articles/supported-mediawiki-formats
/articles/editing-wiki-content
/github/building-a-strong-community/editing-wiki-content
{% data reusables.gated-features.wikis %}
fpt ghes ghae ghec
* * * *
Community

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.

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-wiki %}

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

  2. In the wiki toolbar, click {% octicon "image" aria-hidden="true" %}.

    Screenshot of the toolbar on the edit page of the wiki. The icon to add an image is outlined in dark orange.

  3. In the "Insert Image" dialog box, type the image URL and the alt text (which is used by search engines and screen readers).

  4. Click OK.

Linking to images in a repository

You can link to an image in a repository on {% data variables.product.product_name %} 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/main/img/octocat.png|alt=octocat]]

{% ifversion fpt or ghec or ghes or ghae > 3.6 %}

Adding mathematical expressions and diagrams{% endif %}

{% data reusables.getting-started.math-and-diagrams %}

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