FAQ

Frequently asked questions

Short answers first; each links to the page with the detail where there is one.

What is ssg?

Static Site Generator: an open-source static site generator written in Rust that audits the site it builds. See the features.

Is Shokunin the same project as ssg?

Yes. Shokunin was renamed Static Site Generator in version 0.0.36. See Formerly Shokunin.

How do I install it?

cargo install ssg, or a prebuilt package from the GitHub releases. See getting started.

Which Rust version do I need?

Rust 1.89 or newer to build from source. The prebuilt packages need no Rust at all.

Does the old command line still work?

Yes, with a deprecation warning, until 1.0. See the flag mapping.

Where is the API reference?

At docs.static-site-generator.com.

What does the audit check?

Fifteen gates, from WCAG and structured data to CSP, SRI, links and feeds. See the audit gates.

Where are the themes?

ssg resolves a theme by name with --theme or theme = in ssg.toml. The published themes are on themes.static-site-generator.com; this site uses one of them, Velocity. See themes.

Can it deploy for me?

Yes: ssg deploy targets Netlify, Vercel, Cloudflare Pages, GitHub Pages and S3. See deploys.

How do I know a release is genuine?

Check its SHA-256 sum, its OpenPGP signature and its provenance attestation; the security page shows the commands.

What licence is it under?

MIT or Apache-2.0, at your option. See the terms.