Struct RobotsPlugin 

pub struct RobotsPlugin { /* private fields */ }

Generates a robots.txt file in the site directory.

The file allows all user agents and references the sitemap at {base_url}/sitemap.xml. If a robots.txt already exists, it is not overwritten.

Example

use ssg::plugin::PluginManager;
use ssg::seo::RobotsPlugin;

let mut pm = PluginManager::new();
pm.register(RobotsPlugin::new("https://example.com"));

Implementations

impl RobotsPlugin

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

Creates a new RobotsPlugin with the given base URL.

Examples

use ssg::seo::RobotsPlugin;
use ssg::plugin::Plugin;

let p = RobotsPlugin::new("https://example.com");
assert_eq!(p.name(), "robots");

Trait Implementations

impl Clone for RobotsPlugin

fn clone(&self) -> RobotsPlugin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RobotsPlugin

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

Formats the value using the given formatter.

impl Plugin for RobotsPlugin

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.