Skip to content

brege/gh-social-preview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GitHub Social Preview Plugin


GH Social Preview Sample

This oshea plugin generates a clean social preview card displaying "wyatt brege" centered on a ribbon background in a monospace font. The ribbon background is generated from aperiodic tilings following the silver ratio in the blue-green spectrum of the gruvbox color palette.

Features

  • Standard OpenGraph preview dimensions (1200x630px)
  • Centered, monospace typography
  • Minimal styling
  • Grub

Configuration

Location: gh-social-preview/

The plugin automatically renders "wyatt brege" regardless of markdown input content. Edit in the frontmatter to change.

Installation

git clone https://github.com/brege/gh-social-preview.git

Usage

Generate the main card

oshea convert gh-social-preview/example.md --filename card.pdf -o .

This generates a PDF card with dimensions 1200x630px using the blue and green color palette.

Generate the GitHub profile banner

After generating the card, convert it to PNG and extract the center 30%:

magick card.pdf -gravity center -crop 100%x30%+0+0 +repage banner.png

This is the banner image in brege/brege/README.md.

Requirements

  • oshea: Markdown to PDF converter
  • ImageMagick: Required if also generating the GitHub profile banner

About

An oshea plugin for GitHub Social preview cards

Topics

Resources

License

Stars

Watchers

Forks

Contributors