Skip to the content.

Markdown Cheatsheet

Markdown Cheatsheet

A quick-reference guide for standard Markdown and GitHub Flavored Markdown (GFM) formatting, covering headings, tables, task lists, code blocks, and alert callouts.

Basic Syntax

# Heading 1 (H1)
## Heading 2 (H2)
### Heading 3 (H3)
#### Heading 4 (H4)

**Bold Text** or __Bold Text__
*Italic Text* or _Italic Text_
***Bold and Italic***

- Unordered List Item 1
- Unordered List Item 2
  - Nested Unordered Item (indent 2 spaces)

1. Ordered List Item 1
2. Ordered List Item 2
   1. Nested Ordered Item (indent 3 spaces)

[Display Text](https://yoraba.com)                           <!-- Hyperlink -->
![Alt Text](https://yoraba.com/images/logo.svg)              <!-- Image Link -->

> This is a blockquote.
> It can span multiple lines.

---                                                          <!-- Horizontal Rule (3 dashes or stars) -->

Escaping characters: \*this is not italic\*                  <!-- Escape formatting with backslash -->

Tables

Configure tables with header columns, custom alignments, and cell values.

| Header Left | Header Center | Header Right |
| :---        | :---:         | ---:         |
| Align Left  | Align Center  | Align Right  |
| Cell 1      | Cell 2        | Cell 3       |

Task Lists

Task lists render interactive or static checklists (commonly supported in GFM).

- [ ] Incomplete task item
- [x] Completed task item

Code Blocks

Fenced code blocks support syntax highlighting by writing the language identifier next to the opening backticks.

Inline code uses `single backticks` like this.

Fenced code blocks use triple backticks:

```javascript
const greet = () => console.log("Hello World");
greet();
```

```html
<div class="card">
  <p>Static markup</p>
</div>
```

GitHub Flavored Markdown (GFM)

GFM is a modern extension of standard Markdown utilized across GitHub repositories, issues, and PR comments.

~~Strikethrough text~~                                       <!-- Strikethrough uses double tildes -->

Autolinks: https://yoraba.com                                <!-- URLs are automatically hyperlinked -->

Emoji shortcodes: :sparkles: :rocket: :lock:                 <!-- Standard emoji mapping shortcodes -->

# Alert Callouts / Admonitions (Blockquote Alerts)
> [!NOTE]
> This is a standard useful information callout.

> [!TIP]
> This highlights a helpful tip or best practice.

> [!IMPORTANT]
> This represents key, critical guidance for the user.

> [!WARNING]
> This warns about potential issues, deprecations, or risks.

> [!CAUTION]
> This marks highly dangerous operations or potential data losses.