Struct OgImagePlugin 

pub struct OgImagePlugin { /* private fields */ }

Plugin that auto-generates Open Graph social card images.

Implementations

impl OgImagePlugin

pub fn new(base_url: impl Into<String>) -> Self

Creates a new OgImagePlugin with default branding.

Examples

use ssg::og_image::OgImagePlugin;
use ssg::plugin::Plugin;

let p = OgImagePlugin::new("https://example.com");
assert_eq!(p.name(), "og-image");

pub fn with_colors( base_url: impl Into<String>, brand_color: impl Into<String>, text_color: impl Into<String>, ) -> Self

Creates a plugin with custom brand colours.

Examples

use ssg::og_image::OgImagePlugin;
use ssg::plugin::Plugin;

let p = OgImagePlugin::with_colors("https://example.com", "#000", "#fff");
assert_eq!(p.name(), "og-image");

Trait Implementations

impl Clone for OgImagePlugin

fn clone(&self) -> OgImagePlugin

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OgImagePlugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Plugin for OgImagePlugin

fn name(&self) -> &'static str

Returns the unique name of this plugin.

fn after_compile(&self, ctx: &PluginContext) -> Result<(), SsgError>

Called after site compilation completes.

fn before_compile(&self, _ctx: &PluginContext) -> Result<(), SsgError>

Called before site compilation begins.

fn transform_html( &self, html: &str, _path: &Path, _ctx: &PluginContext, ) -> Result<String, SsgError>

Per-file HTML transform hook — called once per HTML file during the fused transform pass.

fn has_transform(&self) -> bool

Returns true if this plugin implements transform_html. Override to true to opt in to the fused transform pass.

fn needs_all_files(&self) -> bool

Returns true if this plugin must always observe the full cache.html_files() list — even during --incremental rebuilds that only invalidated a handful of pages.

fn on_serve(&self, _ctx: &PluginContext) -> Result<(), SsgError>

Called before the development server starts serving files.