pelican-ogimages 0.1.1

Pelican plugin to generate OpenGraph images

Generate OpenGraph images for Pelican

This plugin generate OpenGraph images for each page of your Pelican website. It can be used with the SEO plugin for the OpenGraph meta tags generation.

Installation

This plugin can be installed via:

pip install pelican-ogimages

If not done automatically, add pelican.plugins.ogimages to your existing PLUGINS list.

Pay attention it must before SEO plugin in the list.

Usage

Once installed, the plugin generate a simple image for all the pages and articles. You can override some configuration in your Pelican settings:

OGIMAGES_BACKGROUND_IMAGE = None
OGIMAGES_BACKGROUND_COLOR = "#F5F4EF"

OGIMAGES_SITENAME = True
OGIMAGES_SITENAME_COLOR = "#C74350"
OGIMAGES_SITENAME_POSITION = (100, 100)

OGIMAGES_TITLE_COLOR = "#C74350"
OGIMAGES_TITLE_POSITION = (100, 300)

OGIMAGES_SIZE = (1200, 600)

Advanced customization

For advanced customization, you can override the generation function and set it to OGIMAGES_GENERATOR.

Exemple in the pelicanconf.py:

from PIL import Image, ImageDraw

def generate_og_image(output_path, title, content):
    img = Image.open("og_image_template.png")
    d = ImageDraw.Draw(img)
    d.text((100, 200), title, fill="#5d1c6a", anchor="ls", font_size=60)
    img.save(output_path, "PNG", optimize=True)

OGIMAGES_GENERATOR = generate_og_image

Contributing

Contributions are welcome and much appreciated. Every little bit helps. You can contribute by improving the documentation, adding missing features, and fixing bugs. You can also help out by reviewing and commenting on existing issues.

AI Policy

This project does not allow contributions generated or assisted by Large Languages Models (LLM) or chatbots. This concerns all parts of the project, including, but not limited to, code, documentation, issues and artworks.

License

This project is licensed under the AGPL-3.0 license.

Credits

The project is carried out by the SPIRKOP cooperative 🇪🇺.