ogimage

Documentation

Index

• Constants
• func CacheKey(c Card) [32]byte
• func Generate(c Card) ([]byte, error)
• type Card

Constants

const (
	Width  = 1200
	Height = 630
)

Functions

func CacheKey

func CacheKey(c Card) [32]byte

func Generate

func Generate(c Card) ([]byte, error)

Types

type Card

type Card struct {
	Title       string
	Description string
	SiteName    string
	AccentColor string // optional: #rgb or #rrggbb hex; read from --og-accent in tokens.css
}

Card holds the text and branding inputs for OG image generation. AccentColor is an optional CSS hex color (#rgb or #rrggbb) used for the left stripe and site-name text. When empty or invalid, a neutral slate accent is used so the card is presentable for any generic website.