-
Notifications
You must be signed in to change notification settings - Fork 8
Add a sample post template #430
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.
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
+53
−0
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
bc6c090
Add a post template
frankieroberto 9e89557
Update intro
frankieroberto 855cc2e
Swap order
frankieroberto b9a0ffd
Add a line about metadata being optional
frankieroberto a89ff96
Add example of image with caption
frankieroberto a9798dd
Merge branch 'main' into add-example-template
frankieroberto ca7b183
Add copy code button
frankieroberto 94872c2
simplify
frankieroberto 3c5eb18
Update description content
frankieroberto File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| All metadata is optional except for the title and date. Delete any lines you do not need. | ||
|
|
||
| ```markdown { .nhsuk-code--button } | ||
| --- | ||
| title: This is the title of the post | ||
| description: This description will appear on index pages and when sharing on social media. | ||
| date: 2025-12-01 | ||
| tags: | ||
| - add | ||
| - tags | ||
| - to help group | ||
| - related posts | ||
| author: | ||
| - Your Name | ||
| - Another Name | ||
| opengraphImage: | ||
| src: /your-service/2025/12/post-title/image-name.png | ||
| alt: Alternative text for the lead image | ||
| --- | ||
|
|
||
| An intro paragraph which summarises the whole thing. | ||
|
|
||
| ## Heading | ||
|
|
||
| Some content. | ||
|
|
||
| [A link to another post](/your-service/2025/11/another-post-title/) | ||
|
|
||
| ### Subheading | ||
|
|
||
| More content | ||
|
|
||
|  | ||
frankieroberto marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| This image has a visible caption: | ||
|
|
||
|  | ||
|
|
||
| ``` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.