Skip to main content

A minimalist static site generator

Project description

akari

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.0.tar.gz (10.0 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.0-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for akari_site-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a8095ca7b1ea81b519becebde163600b224bc198d4e0219f7904ac90a86045bd
MD5 c6cb6d0f60413759e0fb75135527d2e5
BLAKE2b-256 15bd009e8d84e16f9fc50dfcd5137c0b6bee584d4b3e5662e366ab2fa3b996f2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for akari_site-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 29f5f27f66441600a00c6b6ac653900c86914f64befaadb1f08bef773b1c7b95
MD5 a5f967334a8cc5878de20e00262b9c92
BLAKE2b-256 52b1ac7ceb010b2275f3d881c404ac367c3d48e2af61435b555ac4fa5e74de3e

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