github_cheat.md

GitHub Markdown cheat sheet

Nearly any Markdown GitHub support.

Head

# 1th level heading
## 2th level heading
### 3th level heading

Text Style

Syntax	Output
**Bold**	Bold
*Italic*	Italic
~~Strikethrough~~	Strikethrough
<ins>Underline</ins>	Underline
<sup>Superscript</sup>	XSuperscript
<sub>Subscript</sub>	XSubscript

Quote

> Text

Text

Code

`code inline`

```markdown
multi line
with code
language highlighting
```

Color

Syntax	Output
`#0969DA`	#0969DA
`rgb(9, 105, 218)`	rgb(9, 105, 218)
`hsl(212, 92%, 45%)`	hsl(212, 92%, 45%)

Link

Syntax	Output
[Extern Link](https://github.com/)	Extern Link
[Link to repository file](../README.md)	Link to repository file
[Link to section](#text-styling)	Link to section

Line break

first line  (2 spaces at the end)
second line

first line
second line

Image

normal

![Alt Text](https://myoctocat.com/assets/images/base-octocat.svg)

for different color schemes

<picture>
   <source media="(prefers-color-scheme: dark)" srcset="https://myoctocat.com/assets/images/base-octocat.svg">
   <source media="(prefers-color-scheme: light)" srcset="https://myoctocat.com/assets/images/base-octocat.svg">
   <img alt="Alt Text" src="https://myoctocat.com/assets/images/base-octocat.svg">
</picture>

List

- item
- item

1. item
2. item

- item
  - First nested list item
    - Second nested list item

• item
• item

1. item
2. item

• item
  • sub item
    • sub sub item

Task

- [x] tasks
- [ ] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740

• tasks
• #739
• https://github.com/octo-org/octo-repo/issues/740

Mention

@pino1536 hello

@pino1536 hello

Footnote

footnote[^1]
[^1]: reference

footnote¹

Alert

> [!NOTE]
> Note.

> [!TIP]
> Tip..

> [!IMPORTANT]
> Important.

> [!WARNING]
> Warning.

> [!CAUTION]
> Caution.

Note

Note.

Tip

Tip..

Important

Important.

Warning

Warning.

Caution

Caution.

Comment

<!-- markdown comment -->

Ignor formating

\*ignore bold\*

*ignore bold*

Table

| collum 1 | collum 2 | collum 3 |
| - | :-: | -: |
| item | item | item |
| item | item | item |

-:    =   right aligned
:-:   =   center aligned

collum 1	collum 2	collum 3
item	item	item
item	item	item

Expand Section

<details>
   <summary>Expand me</summary>

   ### Example
   `Example`
</details>

Expand me

Example

Example

Diagram

Mermaid diagrams

LaTeX

inline

$ \sqrt{3x-1}+(1+x)^2 $

$ \sqrt{3x-1}+(1+x)^2 $

block

$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left(\sum_{k=1}^n b_k^2 \right)$$

$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left(\sum_{k=1}^n b_k^2 \right)$$

Footnotes

1. reference ↩