kamote

python>=3.12 static site generator depending on jinja2, markdown with extensions, frontmatter, feedgen, and optionally pygments.

• installation
  • directly
  • build from source
• usage
• configuration
  • global
  • extensions
    • generate_ configuration
• why this exists
• license

installation

directly

mkdir <project_dir>
cd <project_dir>
uv init
uv add https://beguine.nekoweb.org/src/kamote.tar.gz
uv run kamote init <site_name>

build from source

# for development
curl -LO https://beguine.nekoweb.org/src/kamote.tar.gz && tar -xf kamote.tar.gz
cd kamote
uv sync
source .venv/bin/activate
pytest

# add it as project dependency
mkdir ../<project_dir>
cd <project_dir>
uv init
uv add --editable /path/to/kamote
uv run kamote init <site_name>

usage

kamote comes with the following commands:

• kamote init <site_name>: creates site.json at project root and the directory structure <site_name>/{assets,content,templates}, with placeholder content/index.md and templates/base.html
• kamote build: renders markdown into HTML and copies assets directory into _build
• kamote watch: serves _build to http://localhost:8000 and watches <site_name> for changes

if you have preexisting site files, you can copy them into their appropriate <site_name> subdirectories.

this SSG's error handling currently has a lot of holes, so you will quickly find out things like generate_blog() and generate_archive() are very opinionated, especially about YAML fields.

configuration

kamote init generates a dummy site.json for you to start with.

global

these can be accessed from any HTML template with {{ site.<key> }}.

extensions

enable or disable core features. these are all booleans.

• generate_blog: generates an atom and/or rss 2.0 feed from content/<blog_dir>
• generate_archive: generates archive.json, atom, and/or rss from content/<archive_dir>
• use_gallery: processes image galleries. experimental...
• build_tree: generates a site map

generate_ configuration

why this exists

this is a work in progress i'm dogfooding in two very different contexts. i just hate javascript and how everything is secretly called index.html. it has only been tested on alpine linux 3.23 and debian 13 with python 3.12.

license

kamote is released under the unlicense / kopimi.