Skip to content

Commit b5fb6e8

Browse files
bamnetclaude
andcommitted
Add blog authoring guide to README
Document author setup, social sharing frontmatter, and recommended image dimensions (1200x630px) for Open Graph/Twitter cards. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 4c6b07e commit b5fb6e8

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,42 @@ Once inside the container (or if you have Ruby and Bundler installed locally):
2121
bundle exec jekyll serve
2222
```
2323

24+
## Writing Blog Posts
25+
26+
### Author setup
27+
28+
Authors are defined in `_data/authors.yml`. Each entry maps a short key to a display name and optional Twitter/X handle:
29+
30+
```yaml
31+
bamnet:
32+
name: Brian Michalski
33+
twitter: bamnet
34+
```
35+
36+
To add yourself, add a new entry to the file with your preferred key and full name. Set `twitter: 0` if you don't have a Twitter/X handle (this prevents the jekyll-seo-tag plugin from generating a bogus `twitter:creator` meta tag).
37+
38+
Use your key in post frontmatter:
39+
40+
```yaml
41+
author: bamnet
42+
```
43+
44+
### Social sharing
45+
46+
Every blog post automatically gets Open Graph and Twitter Card meta tags for rich link previews, powered by the `jekyll-seo-tag` plugin. The defaults are:
47+
48+
- **Image:** `/assets/images/blog_banner_1b.jpg` (the blog banner)
49+
- **Title/Description:** pulled from the post's `title` and first paragraph
50+
51+
To customize a post's social preview, add optional frontmatter:
52+
53+
```yaml
54+
description: "A short summary for link previews and search results."
55+
image: /assets/images/my-custom-image.jpg
56+
```
57+
58+
Custom images should be **1200x630px** (1.91:1 ratio). This is the recommended size for both Open Graph (Facebook, LinkedIn, Slack) and Twitter/X large image cards. Smaller images will work but may appear cropped or blurry on high-DPI screens.
59+
2460
## Deploying
2561

2662
Deployments are handled via GitHub Actions. Commits to the `master` branch trigger the `.github/workflows/deploy.yml` workflow, which builds the site and deploys it to GitHub Pages.

0 commit comments

Comments
 (0)