Giter Club home page Giter Club logo

thumb's Introduction

Thumb: Generiert nützliche OpenGraph-Bilder für REDAXO-Seiten

Generiert Vorschau-Bilder für Messenger, Soziale Medien, E-Mail-Clients (og:image).

example

Features

  • Erstellt Vorschau-Bilder anhand der Informationen, die in REDAXO hinterlegt sind
  • Mitgelieferte Fragemente in HTML und SVG für einen einfachen Einstieg
  • Caching der Bilder für DSGVO-konformen Abruf von Vorschaubildern und Zwischenspeichern, um API-Abrufe zu reduzieren.
  • Geplant: Kompatibel zu YRewrite - Verwendet das SEO-Bild von YRewrite, wenn nötig.
  • Geplant: Kompatibel zu URL - Verwendet Titel und SEO-Bild von URL-Profilen, wenn nötig.

Installation

  1. Bei der Installation wird ein Bild thumb_bg.png in den Medienpool kopiert - dieses kann auf Wunsch in den Einstellungen gegen ein eigenes Hintergrundbild getauscht werden.

  2. Erstelle unter https://www.html2image.net/ oder https://hcti.io/ ein Konto und hinterlege in den Einstellungen die heweiligen Zugangsdaten. Wähle ggf. den passenden Anbieter aus.

  3. Erstelle ein Media Manager Profil, z.B. namens thumb, und füge den Effekt Pfad anpassen hinzu. Diesem gibst du den Wert redaxo/cache/addons/thumb/, denn dort befinden sich die bereits heruntergeladenen generierten Bilder.

  4. Verwende in deinem Template im head-Bereich die Methode thumb::getUrl() und übergebe die gewünschte URL (z.B. die des aktuellen Artikels oder des aktuellen URL-Profils), zu der ein Bild generiert werden soll. Als Rückgabewert erhältst du einen Pfad für den Medien-Manager (standardmäßig: /media/thumb/file.png).

Template:

<?php $og_image_url = thumb::getUrl(rex_getUrl()); ?>
<meta property="og:image" content="<?= $og_image_url ?>"/>

Ausgabe:

<meta property="og:image" content="https://www.example.org/media/thumb/11c04adc200effba3c7479688f20e7da.png"/>

Vorlagen

Enthält Fragmente für REDAXO im SVG und HTML-Format für einen einfachen Einstieg.

Tipp: Die Fragmente können bspw. über eine Kopie project-Addon überschrieben werden, kopiere dazu aus dem thumb-Addon-Verzeichnis das Fragment redaxo/src/addons/thumb/fragments/thumb/html.php in das Verzeichnis redaxo/src/addons/project/fragments/thumb/html.php

Benutze die Design-Vorlage im Affinity-2-Format /docs/thumbnail-template.afpub als Ausgangspunkt für eine eigene SVG-Vorlage mit den Abmaßen 1200x600px.

Einstellungs-Seite

Wähle, welche API du verwenden möchtest und hinterlege Zugangsdaten für https://htmlcsstoimage.com/ oder für https://www.html2image.net/ und wähle ggf. ein anderes Hintergrundbild.

Lizenz

MIT Lizenz, siehe LICENSE.md

Autoren

Alexander Walther
http://www.alexplus.de https://github.com/alexplusde

Projekt-Lead
Alexander Walther

Credits

thumb's People

Contributors

alxndr-w avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

thumb's Issues

Add YRewrite-Support

  • Eigenes Fragment
  • SEO-Description
  • SEO-Image
  • SEO-Image-Modi (ersetzen, als Hintergrund verwenden, ignorieren)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.