Adding or editing wiki pages

You can add and edit wiki pages directly on GitHub or locally using the command line.

Who can use this feature?

Wikis are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see " GitHub’s plans ."

Adding wiki pages

On GitHub.com, navigate to the main page of the repository.
Under your repository name, click Wiki .
In the upper-right corner of the page, click New Page .
Optionally, to write in a format other than Markdown, use the "Edit mode" dropdown to choose a different format.
Use the text editor to add your page's content.
In the "Edit message" field, type a commit message describing the new file you’re adding.
To commit your changes to the wiki, click Save Page .

Editing wiki pages

On GitHub.com, navigate to the main page of the repository.
Under your repository name, click Wiki .
Using the wiki sidebar on the right, navigate to the page you want to change. In the upper-right corner of the page, click Edit .
Use the text editor to edit the page's content.
In the "Edit message" field, type a commit message describing the new file you’re adding.
To commit your changes to the wiki, click Save Page .

Adding or editing wiki pages locally

Wikis are part of Git repositories, so you can make changes locally and push them to your repository using a Git workflow.

Cloning wikis to your computer

Every wiki provides an easy way to clone its contents down to your computer. Once you've created an initial page on GitHub, you can clone the repository to your computer with the provided URL:

$ 
git 
clone
 https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.wiki.git

# 
Clones the wiki locally

Once you have cloned the wiki, you can add new files, edit existing ones, and commit your changes. You and your collaborators can create branches when working on wikis, but only changes pushed to the default branch will be made live and available to your readers.

About wiki filenames

The filename determines the title of your wiki page, and the file extension determines how your wiki content is rendered.

Wikis use our open-source Markup library to convert the markup, and it determines which converter to use by a file's extension. For example, if you name a file foo.md or foo.markdown , wiki will use the Markdown converter, while a file named foo.textile will use the Textile converter.

Don't use the following characters in your wiki page's titles: \ / : * ? " < > |. Users on certain operating systems won't be able to work with filenames containing these characters. Be sure to write your content using a markup language that matches the extension, or your content won't render properly.