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

Uploaded Python 3

File details

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

File metadata

  • Download URL: akari_site-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 2a578515db74a0ee93acfdd5808c4ae6c8f54ea2d481b2d0300854577f324447
MD5 1e1a473a74517ca41d69ed210a5db0cf
BLAKE2b-256 a5afae16a71834942f48b0a964be77dbf8e0454f2fde8e19f8c4c9857cae3d99

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for akari_site-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 50b09f40c1986acbb8b751aba007c940983eeb22aa40042c1cd0e89ac1c1f520
MD5 c8b0606c56a40dd9cbb32259ed366f68
BLAKE2b-256 15f69969839fb2ea15730a8e499ea9297d8b747fbd949bcf8274379ccb310321

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