Skip to main content

A minimalist static site generator

Project description

akari

PyPI License

A minimalist static site generator.

Installation

uv tool install akari-site

Quick Start

# Initialize new blog
akari init my-blog
cd my-blog

# Build
akari build

# Or use watch mode for development
akari watch

# Output is in dist/

Features

  • Zero framework bloat - just Python, YAML, and Markdown
  • Dynamic sections - any folder in content/ becomes a section
  • Section-specific templates - customize each section's design
  • Auto-generated navigation - nav builds from discovered sections
  • GitHub Pages ready - outputs pure static HTML to dist/

Using Your Blog

Add Posts

Create files in content/posts/ with YAML front matter:

---
title: "My First Post"
date: 2025-11-30
---

Your content here...

Create New Sections

  1. Create content/my-section/ with Markdown files
  2. Create templates/my-section/ with item.html and index.html
  3. Run akari build

Build

akari build

Output is in dist/. Deploy to GitHub Pages!

Watch for Changes

During development, use watch mode to automatically rebuild when you change files:

akari watch

This will:

  • Perform an initial build
  • Watch content/ and templates/ directories for changes
  • Automatically rebuild when any files change
  • Press Ctrl+C to stop watching

Perfect for development - just save your changes and the site rebuilds automatically!

Project Structure

my-blog/
├── content/
│   ├── about.md
│   ├── posts/
│   │   └── 2025-11-30-hello.md
│   └── projects/
├── templates/
│   ├── base.html
│   ├── posts/
│   │   ├── item.html
│   │   └── index.html
│   └── projects/
│       ├── item.html
│       └── index.html
└── static/
    ├── css/style.css
    ├── logo.svg
    └── favicon.ico

Development

git clone <repo>
cd akari
uv sync
uv tool install .

To test locally:

akari init test-blog
cd test-blog
akari build
python -m http.server --directory dist 8000

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

akari_site-0.1.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

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

akari_site-0.1.1-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

Details for the file akari_site-0.1.1.tar.gz.

File metadata

  • Download URL: akari_site-0.1.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for akari_site-0.1.1.tar.gz
Algorithm Hash digest
SHA256 872b85103de6a59c0a9d467e77a7c14eb7f19c7d02699e043ac5abe5006f2863
MD5 7c67c78d589e2bf417bd7b9c4d6fb28a
BLAKE2b-256 d705891bbe65f13518c4cfc0f54ec9aeec1682440b9647a79e7db5b57cae4bb1

See more details on using hashes here.

File details

Details for the file akari_site-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for akari_site-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ff1deec130777ff5a685ec7677f31ef2f2d889a074bed432da37a6c12322298c
MD5 ab441bdd5e1fec05ae821e9c40623ec3
BLAKE2b-256 03f98c90023b07c5e54e3d695703b6ac569c7a851ce0d071d7d0d4d59bd2a624

See more details on using hashes here.

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