Struct HighlightPlugin 

pub struct HighlightPlugin { /* private fields */ }

Plugin that adds syntax highlighting CSS classes to code blocks.

Runs in after_compile. Finds <pre><code class="language-X"> blocks and injects classes. Also generates highlight.css.

Implementations

impl HighlightPlugin

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

Creates a new HighlightPlugin with the given theme.

Examples

use ssg::highlight::HighlightPlugin;
use ssg::plugin::Plugin;

let p = HighlightPlugin::new("monokai");
assert_eq!(p.name(), "highlight");

pub fn with_theme(theme: impl Into<String>) -> Self

Creates a highlight plugin with the given theme name.

Examples

use ssg::highlight::HighlightPlugin;
use ssg::plugin::Plugin;

let p = HighlightPlugin::with_theme("solarized");
assert_eq!(p.name(), "highlight");

Trait Implementations

impl Clone for HighlightPlugin

fn clone(&self) -> HighlightPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HighlightPlugin

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

Formats the value using the given formatter.

impl Default for HighlightPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for HighlightPlugin

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

Returns the unique name of this plugin.

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 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 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 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.