Markdown Style Guide for This Blog

This article shows every element you can use when writing a post. Each article is a Markdown file in resources/content/posts, and the file name becomes the URL.

Front matter

Each file starts with a block of settings between two --- lines:

---
title: "Your article title"
excerpt: "One or two sentences shown on cards and under the title."
date: "2026-10-12"
category: Guides
author: Your Name
cover: images/posts/your-cover.jpg   # optional
featured: true                       # optional, shows it as Editor's pick
tags: [markdown, guide]              # optional
draft: true                          # optional, hides the post
---

Headings

Use ## for sections and ### for sub-sections. The article title is already the page's main heading, so don't use # inside the body.

A sub-section

Sub-sections are smaller and work well for steps inside a larger section.

Paragraphs and emphasis

Plain paragraphs are separated by a blank line. You can use bold for key terms, italics for emphasis, and inline code for file names or short commands. Links look like this.

Lists

Unordered list:

• First item
• Second item with a bit more text so you can see how longer lines wrap inside a list
• Third item

Ordered list:

1. Write the draft
2. Read it aloud
3. Cut what you don't need

Quotes

Writing is thinking. To write well is to think clearly. That's why it's so hard.

— David McCullough

Code blocks

function readingTime(text, wordsPerMinute = 220) {
    const words = text.trim().split(/\s+/).length;
    return Math.max(1, Math.ceil(words / wordsPerMinute));
}

Tables

Images

Put images in public/images/posts/ and reference them with a path starting at the site root, for example ![A short description](/images/posts/example.jpg). Always write a short description in the brackets; screen readers read it aloud.

That's everything. Use a horizontal rule (---) sparingly, to mark a real change of topic.