Wiki Guide (GitHub)
(needs to be updated for GitHub)
Every new page created should be linked from an existing page. This ensures new pages are part of the organizational structure for better discovery and no pages are orphaned.
GitHub Wiki uses Markdown. Common examples are on this page and the overall GitHub Markdown guide is here.
You can also reference how any page on the wiki is written by clicking the edit page pencil icon in the top right.
-
To create a link to a page on this wiki such as the Wiki Guide (GitHub):
[[Wiki Guide (GitHub)]] -
To create a link to a page on this wiki with a different title:
[[a different title|(Wiki Guide (GitHub)]]- That middle character is a pipe (above the backslash on your keyboard):
|
- That middle character is a pipe (above the backslash on your keyboard):
-
To create a link to a page on the web:
[a page on the web](https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis)
-
To make text bold:
**your text** -
To italicize text:
_your text_
-
To create a table of contents for the page:
[[_TOC_]] -
To insert an image click "Attach a file" and it will upload and link your image:
