Contributing to Wiki

Naming the markdown file:

The GitHub Wiki will use the name of the markdown file as the title of the page. Ensure that you have capitalized the filename in the correct places to reflect how you would want the title presented. e.g.

Filename This-is-a-Guide.md will result in the title This is a Guide.

No duplicate filenames for pages: Ensure that you do NOT create a duplicate filename of an existing file when naming your markdown file. A GitHub MediaWiki entry will resolve from the /wiki root irrespective of the file being in a nested directory therefore the name of a file should only exist once.

Invalid characters: Do NOT use the following characters in your filenames: \ / : * ? " < > |

Adding a Link:

You can link to another Wiki entry by either using the MediaWiki syntax or markdown:

All of the pages on the GitHub Wiki will be accessed using the filename after the /wiki/ root regardless of whether the files are nested or not e.g.

The file at /Guides/contributing-to-wiki/Contributing-to-Wiki.md will be available from the URL /wiki/Contributing-to-Wiki.

MediaWiki

As pages are resolved to the /wiki/ directory, you simply use the page title of the Wiki page you are linking to. Do not include the markdown extension (.md) as you are not trying to link to a file directly. e.g.

The page you are currently on, /wiki/Guides/contributing-to-wiki/Contributing-to-Wiki.md, would be linked as follows:

Code	Result
[[Contributing to Wiki|Contributing-to-Wiki]]	Contributing to Wiki

Markdown

Link to the Wiki page without including the paths e.g.

The file at /Guides/contributing-to-wiki/Contributing-to-Wiki.md would be linked as follows:

Code	Result
[Contributing to Wiki](./Contributing-to-Wiki)	Contributing to Wiki
[Contributing to Wiki](Contributing-to-Wiki)	Contributing to Wiki

Anchor Linking

You can anchor link to any titles, but the title must be in lowercase when being linked. Characters such as a colon must be omitted and spaces must be substituted with hyphens -.

Anchor to a normal title:

The link to the anchor:

[Link to Anchor](#this-is-a-title-anchor)

The anchor that is being linked to:

## This is a Title Anchor:

Anchor to a numbered title:

If you title is a numbered item, then you would:

1. Include the number from the title;
2. Omit the period .;
3. Add a hyphen where the space character would be.

The link to the anchor:

[Link to Numbered Anchor](#1-this-is-a-numbered-anchor)

The anchor that is being linked to:

## 1. This is a Numbered Anchor:

Linking to an anchor link on another page:

If you are anchoring to a title on another page, then you would:

1. Add the page being linked to;
2. Add the hash sign #;
3. Add the title you are linking to, using hyphens - to substitute spaces.

[Anchor link to another page](Contributing-to-Wiki#Anchor-linking)

Include the number if the title is a numbered item:

[Anchor link to another page](Contributing-to-Wiki#1-Anchor-linking)

Adding an Image:

MediaWiki format:

Add your image to the Wiki folder, then you can link it within double square brackets. You will not need to include the path to the file if it is in the same directory as the Wiki page:

[[new-image.png]]

The alt code is added by appending |alt= to the end of the filename e.g.

[[new-image.png|alt=New Image]]

Markdown format:

Add your image to the Wiki folder, then you can link to it using the typical markdown format. You will need to link to the path of the file when using the Markdown format:

![New Image](new-image.png)

![New image](./new-image.png)

![Xubuntu Menu Button](./images/Xubuntu-Logo-s.png)

Adding Tables:

Github has already prepared a thorough guide on tables that can be found here: Organizing information with tables

Reusable images:

Reusable images are images intended to be reused across multiple pages and are located in the /images/ directory. Examples of these types of images would be application icons, such as the Home button for Xubuntu. The images follow a small (16px), medium (32px) and large (64px) format:

Image	Filename