How this blog works¶

This site is a folder of Markdown files. There is no CMS. If you can use Git, you can write here.

Clone and preview¶

git clone https://github.com/namndinh/blog.git
cd blog
uv sync
uv run mkdocs serve

Open http://127.0.0.1:8000. Saving a Markdown file reloads the page.

Add a post¶

1. Create docs/writing/posts/your-slug.md.
2. Use this frontmatter:

---
authors:
  - nam
categories:
  - Notes
comments: false
date: 2026-09-06
description: One or two sentences for the preview and RSS feed.
draft: false
slug: your-slug
tags:
  - notes
---

1. Write an # title, then an excerpt, then <!-- more -->, then the rest.
2. Link the post from docs/writing/index.md if it should show on the Writing page.
3. If you are a new author, add yourself to docs/writing/.authors.yml.

Send it back¶

git checkout -b your-slug
git add docs/writing/posts/your-slug.md
git commit -m "Add post: your slug"
git push -u origin HEAD

Open a pull request against main. Every page also has Edit this page, which opens the file on GitHub.

What you do not need to touch¶

mkdocs.yml, the Material theme, and overrides/ are the site engine. Posts live in docs/. Leave the engine alone unless you are changing the site itself.