Conversation
This is aimed to make it quicker to get started, by giving you a template you can copy with all the relevant fields.
frankieroberto
requested review from
edwardhorsford,
joejulier-nhs and
roobottom
veroje
left a comment
veroje
left a comment
There was a problem hiding this comment.
Great stuff, Frankie. Maybe add some other elements like lists and a table?
|
|
||
| More content | ||
|
|
||
|  |
There was a problem hiding this comment.
Add version with visible description?
There was a problem hiding this comment.
@veroje I'm a bit wary of repeating https://design-history.prevention-services.nhs.uk/guide/using-markdown/ too much - but do you think we should have both examples here?
There was a problem hiding this comment.
I've linked to the markdown guide which has both examples, so I think that's ok for now?
| title: This is the title of the post | ||
| date: 2025-12-01 | ||
| description: This description will appear on index pages. | ||
| 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) |
There was a problem hiding this comment.
Should probably say which of these are optional or not
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@edwardhorsford Updated in b9a0ffd - look ok?
Co-authored-by: Ed Horsford <mail@edwardhorsford.com>
|
Looks good. Can you include a markdown example for a figure with image and figcaption? |
4 participants
This is aimed to make it quicker to get started, by giving you a template you can copy with all the relevant fields.
At some point soon there will also be a 'copy code' button added to this.