Cheat Sheet For Creating A GitHub Wiki / Documentation

Creating a Wiki page for documentation on GitHub is pretty easy. There's really no coding experience necessary and the best thing it's free. I was using this markdown code for creating a R36S Wiki.

Horizontal line

***

Basic text formatting

Example text **Example text**

Example text _Example text_

~~Example text~~ ~~Example text~~

_{Example text} <sub>Example text</sub>

^{Example text} <sup>Example text</sup>

Creating Lists

Example list

1
2
- 2.1
- 2.2

Example list
* 1
* 2
  * 2.1
  * 2.2

Headlines

Example headline 1

# Example headline 1

Example headline 2

## Example headline 2

Example headline 3

### Example headline 3

Example headline 4

#### Example headline 4

Table of Contents list

Example headline 1
- Example headline 2
  - Example headline 3
    - Example headline 4

- [Example headline 1](#example-headline-1)

  * [Example headline 2](#example-headline-2)

    + [Example headline 3](#example-headline-3)

      - [Example headline 4](#example-headline-4)

Quotes and Infoboxes

Example quote

> Example quote

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

Text alignment

centered text

<div align="center">centered text</div>

right aligned text

<div align="right">right aligned text</div>

Table

First Header	Second Header
Content Cell	Content Cell
Content Cell	Content Cell

| First Header  | Second Header |
| ------------- | ------------- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

Use images with the same aspect ratio in tables or it will stretch them which does not look nice.

Table with images

<table>
  <tr>
    <td><a href=''><img src=""  width="" height="" /></a></td>
    <td><a href=''><img src=""  width="" height="" /></a></td>
    <td><a href=''><img src=""  width="" height="" /></a></td>
    <td><a href=''><img src=""  width="" height="" /></a></td>
  </tr>
</table>

Image resizing (with link)

<img src=""  width="100" height="150" />

[<img src=""  width="150" height="150" />]()

[<img src=""  width="100"  />]()

Youtube video link with thumbnail

<a href=""><img src="http://img.youtube.com/vi/INSERTYOUTUBEIDHERE/0.jpg" width="240" height="180" /></a>

Expandable section

CLICK HERE TO EXPAND

Example text

<details>
<summary>CLICK HERE TO EXPAND</summary>
Example text
<img src="https://lh3.googleusercontent.com/qnaJEbFIpvsWJm2KrRI_GIvz1yZdXntgEsCZxy-1pVZi244bCk1RFwdk0ZBRmmvdHiUl6sIa_tsmskL5WLKiigp2AMsIIxinOJNf39qCmacViRGXIOY"  width="100"  />
</details>

Example Badges

ArkOS Community Image

AmberELEC

ROCKNIX

<a href=''><img src="https://img.shields.io/github/forks/manster-zz/R36S-LINKS?style=flat&logo=github&logoColor=whitesmoke&label=Forks"  /></a>
<a href=''><img src="https://img.shields.io/github/stars/manster-zz/R36S-LINKS?style=flat&logo=github&logoColor=whitesmoke&label=Stars"   /></a>
<a href=''><img src="https://img.shields.io/github/contributors-anon/manster-zz/R36S-LINKS?style=flat&logo=github&logoColor=whitesmoke&label=Contributors"   /></a>
<a href=''><img src="https://img.shields.io/github/watchers/manster-zz/R36S-LINKS?style=flat&logo=github&logoColor=whitesmoke&label=Watchers"   /></a>
<a href=''><img src="https://img.shields.io/github/repo-size/manster-zz/R36S-LINKS?style=flat&logo=github&logoColor=whitesmoke&label=Repo%20Size"   /></a>
[![Discord](https://img.shields.io/discord/741895796315914271.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/retrohandhelds)

ArkOS Community Image [![GitHub Release](https://img.shields.io/github/v/release/AeolusUX/ArkOS-R3XS?style=flat)](https://github.com/AeolusUX/ArkOS-R3XS?tab=readme-ov-file#download-links)

AmberELEC [![GitHub Pre-Release](https://img.shields.io/github/release-pre/AmberELEC/AmberELEC-prerelease?style=flat)](https://github.com/AmberELEC/AmberELEC-prerelease/releases/)

ROCKNIX [![GitHub Release](https://img.shields.io/github/v/release/ROCKNIX/distribution?style=flat)](https://github.com/ROCKNIX/distribution/releases)

Shields.io Badges

Badges Generator

Badges for your personal developer branding, profile, and projects

Lots of dynamic GitHub badge examples