Struct StaticSite 

pub struct StaticSite { /* private fields */ }

A static site being assembled into an output directory. Pages are written as index.html under a directory per path (so URLs are clean and extensionless), static assets are copied verbatim, and StaticSite::finish writes a sitemap.xml and robots.txt covering every page added.

Implementations

impl StaticSite

pub fn new( out_dir: impl Into<PathBuf>, base_url: impl Into<String>, ) -> Result<Self>

Prepares an output directory and records the site’s base URL (used for the sitemap and robots entries), for example https://acme.example.

pub fn page(&mut self, path: &str, html: &str) -> Result<&mut Self>

Writes a page’s rendered html for the URL path. The path maps to a clean-URL file: / becomes index.html, /features/ becomes features/index.html. The page is recorded for the sitemap.

pub fn assets(&self, from: impl AsRef<Path>, to: &str) -> Result<()>

Copies a directory of static assets (CSS, fonts, images) from from into the output at to, recursively.

pub fn finish(&self) -> Result<()>

Writes sitemap.xml and robots.txt covering every page added so far. Call once, after all pages are written.