From ba98b2bf35be0a41098653da4fe38c057ed042da Mon Sep 17 00:00:00 2001 From: Simon Branford <4967+branfosj@users.noreply.github.com> Date: Sat, 9 Aug 2025 19:20:13 +0100 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index aa1fc52..ea9522d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # easybuild-blog EasyBuild blog + +## Writing a blog post + +1. Create a `YYYY/MM` folder in `docs/posts/` +1. Inside this folder, create a markdown file (`.md`) with a suitable short name for the post +1. This file will have three sections: + 1. YAML syntax frontmatter + 1. A summary or introduction for the post that will also appear on frontpage + 1. The main part of the post that will only appear on the blog post page +1. If you have authored a post before then add an author entry in `docs/.authors.yml`