Struct ShortcodePlugin 

pub struct ShortcodePlugin;

Plugin that expands shortcodes in Markdown content.

Runs in before_compile to transform content before staticdatagen processes it.

Built-in shortcodes:

• {{< youtube id="..." >}} — responsive YouTube embed
• {{< gist user="..." id="..." >}} — GitHub gist embed
• {{< figure src="..." alt="..." caption="..." >}} — figure with caption
• {{< warning >}}...{{< /warning >}} — admonition blocks
• {{< info >}}...{{< /info >}}
• {{< tip >}}...{{< /tip >}}
• {{< danger >}}...{{< /danger >}}

Trait Implementations

impl Clone for ShortcodePlugin

fn clone(&self) -> ShortcodePlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ShortcodePlugin

impl Debug for ShortcodePlugin

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

Formats the value using the given formatter.

impl Plugin for ShortcodePlugin

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

Returns the unique name of this plugin.

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

Called before site compilation begins.

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

Called after site compilation completes.

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.