Skip to content

Markdown Cheatsheet

Formatting

**bold**  *italic*  ~~strikethrough~~  `inline code`
[Link text](https://example.com)
[Internal link](../about/index.md)

Lists

- Unordered item
    - Nested item

1. Ordered item

- [x] Checked task
- [ ] Unchecked task

Code blocks — always include a language identifier

```csharp
public class Example : MonoBehaviour { }
```

Common identifiers: csharp gdscript python bash yaml json markdown

Admonitions

!!! tip
    Helpful tip.

!!! info "Custom title"
    Neutral info.

!!! warning
    Be careful.

!!! danger
    Serious warning.

!!! example
    Worked example.

??? note "Collapsible"
    Click to expand.
Collapsible

This is the collapsed content.

Tabbed content

=== "Tab One"
    Content for tab one.

=== "Tab Two"
    Content for tab two.

Content for tab one.

Content for tab two.

Tables

| Header A | Header B |
|----------|----------|
| Cell     | Cell     |

Images

![Alt text](../assets/images/example.png)
*Caption.*

Mermaid diagrams

```mermaid
graph LR
    A[Player] --> B[PlayerController]
    B --> C[Health]
```

graph LR
    A[Player] --> B[PlayerController]
    B --> C[Health]

Emoji — browse all at squidfunk.github.io/mkdocs-material/reference/icons-emojis

:material-gamepad-variant:  :material-code-braces:  :fontawesome/brands/github:

Grid cards

<div class="grid cards" markdown>

-   :material-gamepad-variant:{ .lg .middle } **Card Title**

    ---

    Description.

    [:octicons-arrow-right-24: Link](target.md)

</div>

Keyboard keys

++ctrl+s++  ++enter++  ++alt+f4++

Ctrl+S · Enter

Math (LaTeX)

Inline: \(E = mc^2\) → \(E = mc^2\)

Block: 

\[ \sum_{i=1}^{n} i = \frac{n(n+1)}{2} \]