Back to Home
Documentation & Cheat Sheet

Markdown Syntax Reference

Complete guide to CommonMark, GitHub Flavored Markdown (GFM), KaTeX math equations, and Mermaid diagrams.

Headings

Markdown Input
Rendered Output
# Heading 1
## Heading 2
### Heading 3

Heading 1

Heading 2

Heading 3

Text Formatting

Markdown Input
Rendered Output
**Bold text**
*Italic text*
~~Strikethrough~~
[Link text](https://example.com)
![Alt text](image.png)

Bold text

Italic text

Strikethrough

Link text

Embedded image preview

Lists & Task Checklists

- Bullet Item 1
- Bullet Item 2
- [x] Completed task
- [ ] Incomplete task
  • Bullet Item 1
  • Bullet Item 2
Completed task
Incomplete task

KaTeX Math Notation

Use single $ for inline math and double $$ for block equations.

$$f(x) = \int_{-\infty}^{\infty} \hat{f}(\xi)\,e^{2 \pi i \xi x}\,d\xi$$

Mermaid Diagrams

Use code blocks with language set to mermaid:

```mermaid
graph LR
  A[Client] -->|HTTP Request| B(Next.js Server)
  B -->|Query| C[(IndexedDB Cache)]
```

Keyboard Shortcuts

ShortcutAction
Cmd / Ctrl + KOpen Command Palette & File Switcher
Cmd / Ctrl + SSave snapshot & persist file
Cmd / Ctrl + BToggle Sidebar
Cmd / Ctrl + PPrint / Export to PDF