Struct DraftPlugin 

pub struct DraftPlugin { /* private fields */ }

Plugin that filters draft content before compilation.

In before_compile, scans content files for draft: true in frontmatter and renames them to .md.draft so staticdatagen skips them. In after_compile, restores the originals.

Implementations

impl DraftPlugin

pub const fn new(include_drafts: bool) -> Self

Creates a new DraftPlugin.

If include_drafts is true, draft files are left in place.

Examples

use ssg::drafts::DraftPlugin;
use ssg::plugin::Plugin;

let p = DraftPlugin::new(false);
assert_eq!(p.name(), "drafts");

Trait Implementations

impl Clone for DraftPlugin

fn clone(&self) -> DraftPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DraftPlugin

impl Debug for DraftPlugin

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

Formats the value using the given formatter.

impl Plugin for DraftPlugin

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.