Skip to content

Commit b963e80

Browse files
authored
Merge pull request #10 from branfosj/instructions
Instructions for writing a post
2 parents bf8de86 + ba98b2b commit b963e80

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,12 @@
11
# easybuild-blog
22
EasyBuild blog
3+
4+
## Writing a blog post
5+
6+
1. Create a `YYYY/MM` folder in `docs/posts/`
7+
1. Inside this folder, create a markdown file (`.md`) with a suitable short name for the post
8+
1. This file will have three sections:
9+
1. YAML syntax frontmatter
10+
1. A summary or introduction for the post that will also appear on frontpage
11+
1. The main part of the post that will only appear on the blog post page
12+
1. If you have authored a post before then add an author entry in `docs/.authors.yml`

0 commit comments

Comments
 (0)