Guide
How this site works
Every guide on this site is one Markdown file in src/content/guides/. The
filename becomes the URL, so this file — hello-world.md — is served at
/guides/hello-world/.
Adding a guide
- Create
src/content/guides/my-new-guide.md - Fill in the frontmatter block at the top
- Write the guide
git add . && git commit -m "Add my new guide" && git push
GitHub Actions builds the site and publishes it. No other steps.
The frontmatter fields
| Field | Required | Notes |
|---|---|---|
title |
yes | Shown on the card and as the page <h1> |
description |
yes | Card subtitle, meta description, RSS summary |
date |
yes | YYYY-MM-DD; sorts the guide list |
updated |
no | Shown next to the date when present |
tags |
no | A list of strings |
youtubeUrl |
no | Renders a “watch the video” link at the top |
draft |
no | true hides it from the built site |
The schema is enforced at build time in src/content.config.ts. A typo in a
field name fails the build with a clear message rather than shipping a broken
page — that’s the point of defining it.
Drafts
Set draft: true and the guide still shows up in npm run dev but is excluded
from the production build. Useful for writing a guide before the video is up.
Keep slugs stable once a URL is in a video description. Renaming the file changes the URL and breaks that link permanently.