Up: Index | Prev: Overview | Next: Quick Start

Prerequisites

Python interpreter

A Python interpreter with version 3.11 or newer must be installed. To obtain a copy:

Linux

Linux users will almost certainly have a suitable Python interpreter pre-installed. If not, refer to your distribution's documentation.

Windows

Windows users can install the latest Python interpreter from the Microsoft store.

Mac

Mac users can download an installer from python.org.

Knowledge of Jinja templates

All the heavy lifting is done by the Jinja templating engine. SSG just wrangles data that has been declared within a hierarchy of files and presents it as the context for Jinja. The more you know about Jinja, the more you can do with SSG.

Knowledge of TOML

What isn't done by Jinja is largely done by TOML. TOML is used to link templates with output pages, control how pages relate to one another and provide a repository for free-form data that can be supplied as context for the templates. The better your understanding of TOML, the more sense SSG will make.