Homelab
Example Guide — and Formatting Template
Shows the guide layout: wide column, auto table of contents, and the formatting helpers you can use.
intermediate updated June 18, 2026
Overview
Open with what the guide accomplishes and who it’s for. Every ## and ###
heading in a guide automatically appears in the table of contents on the right
and gets a clickable anchor.
Prerequisites
- A thing you need
- Another thing you need
Step 1 — Do the first thing
Use inline code for small references, and fenced blocks with a language for
commands so they’re syntax-highlighted:
docker compose pull && docker compose up -dA sub-step
Sub-steps nest under their parent in the contents list.
Step 2 — Verify
Tables work well for settings and options:
| Setting | Value | Notes |
|---|---|---|
| Port | 7777 | UDP |
| Region | us-west | optional |
Wrapping up
Summarize, and link to related guides or projects.