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.2.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.2-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: akari_site-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 1f8c09bfdc09b34945ad52f4dc1640a4926be4a1ca86bed9e5e17b5bb859bfe3
MD5 7f8926dcc87653287558c1de99ffd331
BLAKE2b-256 1076277965c25125b9d85eeed77d4391adc9d9ee6ccc22ce27b07ed8000ff772

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for akari_site-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 228171948a2e5dbdd186deff2860574da2538d73c880638b663b3cf079c0cac5
MD5 a6c9fea004a0ae976c28e4477edee2e3
BLAKE2b-256 13e864027f8a37f05180c7eead18835976182a2078a46b879039a86763ec6125

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