How this playbook works
The short version
- Every page is a Markdown (
.md) or MDX (.mdx) file undersrc/content/docs/. - Folders become sidebar sections automatically.
- Push to
main— your host (Cloudflare Pages / Vercel / Netlify) rebuilds and deploys.
Folder layout
src/content/docs/├── index.md # Landing page├── guides/ # Long-form articles, how-tos├── cheatsheets/ # Quick reference pages├── diagrams/ # Mermaid-based architecture diagrams├── mind-maps/ # Markmap mind maps├── slides/ # Slide decks (Slidev / Reveal)└── infographics/ # SVG/PNG infographics with a short narrativeAuthoring workflow
The fastest loop for writing:
npm run dev # starts local preview at http://localhost:4321# edit a .md file — the site hot-reloadsWhen you’re happy:
git add .git commit -m "add: RAG-from-scratch cheatsheet"git pushYour deploy platform picks up the push and ships the new version in ~30 seconds.
Frontmatter cheatsheet
Every page has a small YAML block at the top. The essentials:
---title: Readable title shown in nav & tabdescription: One-line summary, also used for SEOsidebar: order: 2 # lower = higher in the sidebar badge: text: New variant: tip---Tagging & organizing
Starlight gives you nav + full-text search out of the box. If you want Obsidian-style tags or backlinks later, two good options are:
- Astro Starlight Sidebar Topics for nested topic groups
- Quartz if you decide you want the full “digital garden” feel
Start simple — you can always migrate content later because it’s all just Markdown.