Struct TemplatePlugin 

pub struct TemplatePlugin { /* private fields */ }

Plugin that post-processes compiled HTML through templates.

Runs in the after_compile phase, with the MiniJinja templates under <template_dir>/tera of the build context. For each HTML file in site_dir:

1. Reads the companion .meta.json sidecar (from frontmatter extraction)
2. Determines the layout from frontmatter (layout field, default: page)
3. Takes the page’s rendered content out of the compiled document (the inside of <main>) and renders it through the template chain
4. Writes the rendered result back to the same file

Falls back gracefully if no templates directory exists. The template_dir of a TemplateConfig passed to Self::new does not override the context’s: it only carries the globals and escaping settings.

Implementations

impl TemplatePlugin

pub const fn new(config: TemplateConfig) -> Self

Creates a new TemplatePlugin with the given configuration.

Examples

use ssg::plugin::Plugin;
use ssg::template_engine::TemplateConfig;
use ssg::template_plugin::TemplatePlugin;

let p = TemplatePlugin::new(TemplateConfig::default());
assert_eq!(p.name(), "templates");

pub fn from_template_dir(template_dir: &Path) -> Self

Creates a TemplatePlugin that looks for templates in the standard templates/tera/ subdirectory of the template dir.

Examples

use ssg::plugin::Plugin;
use ssg::template_plugin::TemplatePlugin;
use std::path::Path;

let p = TemplatePlugin::from_template_dir(Path::new("templates"));
assert_eq!(p.name(), "templates");

Trait Implementations

impl Debug for TemplatePlugin

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

Formats the value using the given formatter.

impl Plugin for TemplatePlugin

Available on crate feature templates only.

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.