Skip to main content

ssss is a static site generator that uses Jinja2 and Markdown to build fast, lightweight static HTML sites. Scaffold a new site in seconds with --scaffold and run it anywhere.

Project description

example workflow codecov

Super Simple Static Site (ssss)

ssss is a static site generator that uses Jinja2 and Markdown to build fast, lightweight static HTML sites. Scaffold a new site in seconds and run it anywhere.

Installation

The recommended way to install ssss is via pipx, which installs Python CLI tools in isolated environments and makes them available globally:

pipx install ssss

On Arch Linux, install pipx first if needed:

sudo pacman -S python-pipx

Alternatively, if you are in an active virtual environment:

pip install ssss

Usage

Quick start

Run --scaffold to initialize a new project, write starter templates and content, and build the site in one step:

ssss --scaffold

This creates:

ssss.yml                          # configuration file
site/
  source/
    index.md                      # starter content
    _templates/
      base.html                   # HTML base layout (Pico CSS included)
      default.j2                  # default Jinja2 template
  build/
    index.html                    # generated output

Init only

Use --init if you only want to create the configuration file and directory structure, without writing any template or content files:

ssss --init

Build an existing site

Once a configuration file exists, run ssss without any flags to build:

ssss

Use a custom config file

ssss --config path/to/custom.yml

Configuration

Configure your site via ssss.yml. The site section defines site-wide variables accessible in all templates and content files:

site:
  title: My Site
  description: A site built with ssss.
  author: Your Name
  url: https://example.com

Templates

Templates live in site/source/_templates/. ssss uses staticjinja for rendering.

  • base.html — base HTML layout, extended by Jinja2 templates
  • default.j2 — default template, applied to all Markdown files without a dedicated template
  • __<stem>.j2 — template applied only to the content file with the matching stem

The default scaffold includes Pico CSS via CDN — a minimal, classless CSS framework for semantic HTML that makes every page look clean with zero extra effort.

CLI reference

ssss --help
Flag Description
--scaffold Create config, directories, and starter files, then build
--init Create config and directories only
--config, -c Path to a configuration file
--version, -v Print the version and exit
--help, -h Show help and exit

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssss-1.2.0.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ssss-1.2.0-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file ssss-1.2.0.tar.gz.

File metadata

  • Download URL: ssss-1.2.0.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ssss-1.2.0.tar.gz
Algorithm Hash digest
SHA256 f83ae4cdfa743f7b8dbfcdaafccde5a0763c9e683cdaac33245d3c84b68a1370
MD5 4d6660bc55178bfe9044e6073c6d8ce5
BLAKE2b-256 54a4d68f15c3289d9af5105aad96006e6e634533c292e4d24c8e0feaa6be7ea0

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssss-1.2.0.tar.gz:

Publisher: publish.yml on the-commits/super-simple-static-site

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ssss-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: ssss-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ssss-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1ab839658d044ba97ba1fba6592e7b3d3b163055d973f4bc5f455ecc13068034
MD5 37cf462ac9b71cc0d1d174cbb94714ad
BLAKE2b-256 92315e110479a30835462739862277603f868f3c37deefe200b63769eb26cd5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssss-1.2.0-py3-none-any.whl:

Publisher: publish.yml on the-commits/super-simple-static-site

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page