Skip to content

Adds more details for publishing blog post #272

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.

Sign up for GitHub

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
ElizabethN merged 2 commits into from
Apr 22, 2026
Merged

Adds more details for publishing blog post #272

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4f415cd
Adds more details for publishing blog post
ElizabethN Apr 17, 2026
6c3078a
Adds "published at" to metadata
ElizabethN Apr 22, 2026
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
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ It is built using the PHP static-site generator [Sculpin](https://sculpin.io), a

## Submitting blog posts

### Creating content

To submit a blog post, create a pull request, adding a new file under `source/_posts/` in the format `{4-digit Year}-{2-digit Month}-{2-digit Day}-{dash-separated title}.md`.
All posts are written using Markdown with frontmatter YAML, and should have the following general format:

Expand All @@ -17,13 +19,21 @@ tags:
author:
name: Your name
url: A URL with information on you
published_at: DD Month YYYY
---
Markdown content starts here
Markdown content starts here - no header title needed
```

## Developing/maintaining the site
### Adding images

Images for the post should be saved in `post-images/YEAR/folder_for_your_post` and referenced with the full path for the image to render properly on the website.

### Previewing and publishing your post

The site
After your PR is created, you (or someone else) can preview your post by adding the `safe to preview` label to the PR. This will trigger deployment to a testing server, and the PR can be merged once checked. It's important to preview both on desktop _and_ a mobile device before merging.


## Developing/maintaining the site

### Requirements

Expand Down
Loading