A Wiki is a collaborative way to quickly create documentation with multiple nested pages.
A wiki would serve as a knowledge base for your repo or organization.
To use wikis:
Go to repo settings -> Features -> Check Wiki (Optionally restrict editing to collaborators only)
Now you just can go to the Wiki tab of your repo and Create the first page.
Note
Github Wikis can be used for Free in Public Repos
When you create a page you can use various markup languages:
- AsciiDoc
- Creole
- Markdown
- MediaWiki
- Org-mode
- Pod
- Rdoc
- Textile
- reStructuredText
Here is an example of how to link other pages, by providing the page title as the link.
[Home Page] (Home) #Generate a direct link to the home page in this wiki pageNote
Remember:
- For public repos: the wiki is available to the public
- For private repos: only people with access to the repository can access it
A wiki can be cloned via HTTPS to edit the files locally and push upstream the results.
Any wiki page can be created, edited or deleted. In the Github UI.
Note
The Home Page can not be deleted
In a wiki the are 2 optional parts to the pages:
- Footer: Which is define by a page name
_Footer - Sidebar: Which is define by a page name
_Sidebar