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`