-
-
Notifications
You must be signed in to change notification settings - Fork 251
Improve social media image generation configuration and documentation #794
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
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: benbalter <282759+benbalter@users.noreply.github.com>
Co-authored-by: benbalter <282759+benbalter@users.noreply.github.com>
Co-authored-by: benbalter <282759+benbalter@users.noreply.github.com>
Co-authored-by: benbalter <282759+benbalter@users.noreply.github.com>
Co-authored-by: benbalter <282759+benbalter@users.noreply.github.com>
Co-authored-by: benbalter <282759+benbalter@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive configuration and documentation for the jekyll-og-image plugin to automatically generate Open Graph images for social media sharing. The changes establish configuration defaults and provide extensive documentation on customizing OG images for different post types.
- Expands
og_imageconfiguration in_config.ymlwith detailed canvas, font, color, and layout settings - Adds two new documentation files explaining OG image configuration and providing examples
- Updates README.md to highlight the OG image feature and link to configuration documentation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
_config.yml |
Adds comprehensive og_image configuration with canvas dimensions, fonts, colors, margins, and comments about the custom fork |
README.md |
Adds Features section highlighting OG image generation and links to configuration documentation |
.github/og-image-config.md |
New documentation file explaining OG image configuration, usage, troubleshooting, and specifications |
.github/og-image-examples.md |
New documentation file providing multiple examples of OG image customization for different post types |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
_config.yml
Outdated
| font_family: "Helvetica, Bold" | ||
| color: "#2f313d" | ||
| content: | ||
| font_family: "Helvetica, Regular" |
Copilot
AI
Oct 30, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The font family specification 'Helvetica, Bold' uses a non-standard format. Font weight should typically be specified separately from font family. Verify that the jekyll-og-image plugin accepts this format, as standard font specifications would separate family ('Helvetica') and weight/style ('Bold') into different properties.
| font_family: "Helvetica, Bold" | |
| color: "#2f313d" | |
| content: | |
| font_family: "Helvetica, Regular" | |
| font_family: "Helvetica" | |
| font_weight: "bold" | |
| color: "#2f313d" | |
| content: | |
| font_family: "Helvetica" | |
| font_weight: "normal" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The format "Helvetica, Bold" is correct for the jekyll-og-image plugin. This plugin-specific format passes the entire string to the underlying image library (libvips), which expects "Font Name, Weight" as a single parameter. The upstream documentation confirms this is the standard format (see examples using "Roboto, Bold" and "Roboto, Regular").
Added clarifying comments in commit 2277c54.
_config.yml
Outdated
| font_family: "Helvetica, Bold" | ||
| color: "#2f313d" | ||
| content: | ||
| font_family: "Helvetica, Regular" |
Copilot
AI
Oct 30, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The font family specification 'Helvetica, Regular' uses a non-standard format. Font weight should typically be specified separately from font family. Verify that the jekyll-og-image plugin accepts this format, as standard font specifications would separate family ('Helvetica') and weight/style ('Regular') into different properties.
| font_family: "Helvetica, Regular" | |
| font_family: "Helvetica" | |
| font_weight: "Regular" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The format "Helvetica, Regular" is correct for the jekyll-og-image plugin. This plugin-specific format passes the entire string to the underlying image library (libvips), which expects "Font Name, Weight" as a single parameter. The upstream documentation confirms this is the standard format.
Added clarifying comments in commit 2277c54.
.github/og-image-config.md
Outdated
| height: 600 # Canvas height in pixels | ||
| background_color: "#FFFFFF" # Background color | ||
| header: | ||
| font_family: "Helvetica, Bold" # Title font |
Copilot
AI
Oct 30, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The font family specification 'Helvetica, Bold' uses a non-standard format. Font weight should typically be specified separately from font family. Verify that the jekyll-og-image plugin accepts this format, as standard font specifications would separate family ('Helvetica') and weight/style ('Bold') into different properties.
| font_family: "Helvetica, Bold" # Title font | |
| font_family: "Helvetica" # Title font family | |
| font_weight: "bold" # Title font weight |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The format "Helvetica, Bold" is correct for the jekyll-og-image plugin. This is the plugin-specific format required by the underlying library (libvips). Added a note in the documentation explaining this format in commit 2277c54.
.github/og-image-config.md
Outdated
| font_family: "Helvetica, Bold" # Title font | ||
| color: "#2f313d" # Title color | ||
| content: | ||
| font_family: "Helvetica, Regular" # Description font |
Copilot
AI
Oct 30, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The font family specification 'Helvetica, Regular' uses a non-standard format. Font weight should typically be specified separately from font family. Verify that the jekyll-og-image plugin accepts this format, as standard font specifications would separate family ('Helvetica') and weight/style ('Regular') into different properties.
| font_family: "Helvetica, Bold" # Title font | |
| color: "#2f313d" # Title color | |
| content: | |
| font_family: "Helvetica, Regular" # Description font | |
| font_family: "Helvetica" # Title font family | |
| font_weight: "Bold" # Title font weight | |
| color: "#2f313d" # Title color | |
| content: | |
| font_family: "Helvetica" # Description font family | |
| font_weight: "Regular" # Description font weight |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The format "Helvetica, Regular" is correct for the jekyll-og-image plugin. This plugin uses "Font Name, Weight" as a single string parameter, which is passed to libvips. Added documentation clarification in commit 2277c54.
|
@copilot how can I make the social media images more visually engaging? |
Here are several ways to make the OG images more visually engaging: 1. Use gradient borders (already supported): og_image:
border_bottom:
width: 30 # Thicker border
fill:
- "#4285F4"
- "#34A853"
- "#FBBC05"
- "#EA4335"2. Add background images for visual interest: og_image:
canvas:
background_image: "/assets/images/pattern.jpg"3. Customize per-post for topic-specific colors: ---
title: "Leadership Post"
og_image:
border_bottom:
fill: ["#EA4335"] # Red for leadership
---4. Increase border width for more impact: border_bottom:
width: 40 # Current: 205. Try custom fonts like Roboto or Open Sans (ensure they're available on the build system) The documentation in |
Co-authored-by: benbalter <282759+benbalter@users.noreply.github.com>
Summary
Successfully improved social media (Open Graph) image generation for benbalter.github.com.
Recent Changes
font_familyformat "Font Name, Weight" is plugin-specificChanges Made
Configuration Enhancements (_config.yml)
Documentation Created
✅ Comprehensive configuration guide (.github/og-image-config.md)
✅ Customization examples (.github/og-image-examples.md)
✅ Updated README.md to highlight OG image feature
Benefits
Technical Details
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.