Skip to content

Commit

Permalink
Merge pull request #62 from Kuadrant/blog-guide
Browse files Browse the repository at this point in the history
Add info to readme for writing blog posts
  • Loading branch information
openshift-merge-bot[bot] authored Aug 6, 2024
2 parents 4797c13 + 463d68b commit 1519528
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,30 @@ You will need:

# Publishing
Published via GH action, see `.github/workflows/eleventy_build.yml`

# Blog

Blog posts are stored as markdown files in `src/blog/`.
The name of the file doesn't matter.
Metadata is included at the top of the file like this:

```markdown
---
title: My blog post
date: 2024-08-02
author: Me
---
```

This will ensure the blog post title shows up in the post list, grouped by year and sorted by date.
The title, author and date will also render in a styled manner at the top of the post page.

If you want to include images, you can create a folder in the `src/blog/` folder, and put the markdown file there, along with any images.
Then you can insert an image like this:

```njk
{% image "./myimage.png", "My image" %}
```

The post list template is at `src/_includes/postslist.njk`.
The post page template is at `src/_includes/layouts/post.njk`.

0 comments on commit 1519528

Please sign in to comment.