ReferenceApril 21, 2026·1 min read

Markdown and MDX cheatsheet

Every piece of syntax you'll need when authoring resources in this template.

Headings

## H2
### H3
#### H4

Inline formatting

**bold**, *italic*, ~~strikethrough~~, `inline code`, [link](https://example.com).

Lists

- bullet one
- bullet two
  - nested
 
1. numbered
2. numbered

Code blocks with syntax highlighting

```ts
export function add(a: number, b: number) {
  return a + b;
}
```

Renders with rehype-pretty-code using the GitHub theme — light and dark variants both ship.

Tables (GFM)

| Col A | Col B |
|-------|-------|
| 1     | 2     |

Callouts via blockquote

Tip: keep descriptions under 160 characters so they render cleanly in search results and social previews.

Embedding React components

You can drop any imported component directly into MDX. Add imports to lib/mdx.tsx to expose them globally without per-file imports.