Skip to content

add instructions for writing a post #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 12, 2025
Merged

add instructions for writing a post #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`