Skip to content
Merged
Changes from 2 commits
Commits
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
50 changes: 50 additions & 0 deletions app/guide/a-sample-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
layout: page
title: A sample post template
description: You can use this template to get you started.
eleventyNavigation:
parent: Guide
---

This template contains all the possible metadata you can add to a post, and some sample markdown for the content (see [full markdown guide](/guide/using-markdown/)).

You don’t have to use this template, but it may be helpful.

To use it, create a new subfolder for your post, add an `index.md` file in the subfolder and copy in template below.

For any metadata not needed, you can delete those lines.

```markdown
---
title: This is the title of the post
date: 2025-12-01
description: This description will appear on index pages.
Comment thread
frankieroberto marked this conversation as resolved.
Outdated
tags:
- add
- tags
- to help group
- related posts
author:
- Your Name (optional)
- Another Name
opengraphImage:
src: /your-service/2025/12/post-title/image-name.png
alt: Alternative text for the lead image (appears when sharing)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should probably say which of these are optional or not

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think technically everything is optional apart from title and date. Wasn't sure how best to make this clear though. Perhaps rather than adding (optional) it's better to have a line above the template saying something like:

All metadata is optional except for the title and date. Delete any lines you do not need.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@edwardhorsford Updated in b9a0ffd - look ok?

Comment thread
frankieroberto marked this conversation as resolved.
Outdated
---

An intro paragraph which summarises the whole thing.

## Heading

Some content.

[A link to another post](/your-service/2025/11/another-post-title/)
Comment thread
frankieroberto marked this conversation as resolved.

### Subheading

More content

![Alt text for an image](/your-service/2025/12/post-title/image.jpg)
Comment thread
frankieroberto marked this conversation as resolved.


```
Loading