A fast, simple static site generator built with Kotlin that works out of the box with minimal setup.

1. Create a config.json:

{
  "siteName": "My Blog",
  "baseUrl": "https://example.com",
  "description": "My awesome blog",
  "author": "Your Name"
}

2. Add some content in posts/ or content/:

---
title: Hello World
---

# Hello World

This is my first post!

3. Generate your site:

./amper run -- --root-path .

That's it! No templates required - Statik includes clean, minimal built-in templates to get you started.

This README provides quick guidelines for both human contributors and AI coding assistants.

• Build: ./amper
• Run: ./amper run
• Test: ./amper test
• Single test: ./amper test --tests <TestClassName> or ./amper test --tests <TestClassName.testMethodName>
• Build and watch a documentation website: ./amper run -- --root-path=./documentation --w
• Test Docker image: ./test-docker.sh (comprehensive)

• Package Structure: Follow com.potomushto.statik.* namespace convention
• Imports: Group imports by package, separate standard library imports
• Naming:
  • Classes: PascalCase (e.g., BlogEngine)
  • Functions/Properties: camelCase (e.g., generateSite())
  • Constants: SCREAMING_SNAKE_CASE
• Documentation: Add KDoc comments for public APIs
• Null Safety: Prefer non-nullable types, use safe calls (?.) or the Elvis operator (?:) when needed
• Testing: Write unit tests for core functionality

The project uses the Amper build system with dependencies defined in module.yaml.

The project is published as a Docker image at ghcr.io/ptmt/statik:latest.

To build the Docker image for your platform:

# Build for current platform (recommended)
docker build --platform linux/$(uname -m) -t statik .

# Or build for specific platform
docker build --platform linux/amd64 -t statik .     # Intel/AMD
docker build --platform linux/arm64 -t statik .     # Apple Silicon/ARM

To generate a static website from your current directory:

docker run --rm -v $(pwd):/github/workspace ghcr.io/ptmt/statik:latest run -- --root-path .

To build and watch a documentation website:

docker run --rm -v $(pwd):/github/workspace -p 8080:8080 ghcr.io/ptmt/statik:latest run -- --root-path . --w

Note: Your project directory must contain:

• config.json with site configuration
• content/ or posts/ directory with Markdown files
• templates/ directory with Handlebars templates (optional - see below)

Statik includes built-in fallback templates, so you can start generating sites immediately without creating any templates. However, you can customize the look by creating your own .hbs templates:

• templates/home.hbs - Homepage template (shows list of posts and pages)
• templates/post.hbs - Individual blog post template
• templates/page.hbs - Static page template

If a template file doesn't exist, Statik will use a clean, minimal built-in template instead.

• home.hbs: siteName, description, baseUrl, posts[], pages[]
• post.hbs: post (title, content, date, metadata), siteName, baseUrl, pages[]
• page.hbs: page (title, content, metadata), siteName, baseUrl, pages[]

You can also use partials in templates/partials/ for shared components like headers and footers.

Example config.json:

{
  "siteName": "My Blog",
  "baseUrl": "https://example.com",
  "description": "A static site built with Statik",
  "author": "Your Name",
  "theme": {
    "templates": "templates",
    "assets": "static",
    "output": "build"
  },
  "paths": {
    "posts": "posts",
    "pages": "content"
  }
}

You can use this Docker image in GitHub Actions workflows:

- name: Generate static site
  uses: docker://ghcr.io/ptmt/statik:latest
  with:
    args: run -- --root-path .

The Docker image contains the pre-built Statik application and all necessary dependencies.

Use Ktor version 3. This is the correct way for static files to be declared in Ktor 3:

staticFiles("/", Paths.get(rootPath, config.theme.output).toFile()) { }