Plombir

A modern, extremely fast static site generator written in Crystal.

Write. Build. Ship.

Plombir combines Jekyll-style simplicity (Markdown, frontmatter, layouts, convention over configuration) with a modern content model, compiled to a single native binary. No Node.js required. Also listed on Shardbox.

Licensed under the Mozilla Public License 2.0 (MPL-2.0). See LICENSE.

Quick start

Install (Linux x86_64/ARM64) or build from source:

sh install.sh

Zero to deployed site:

plombir new my-site
cd my-site
plombir dev       # live preview at http://localhost:3000
plombir build     # static HTML -> dist/
plombir check     # links, assets, feeds: must exit 0

Ship dist/ to any static host (deployment guide):

rsync -av --delete dist/ my-server:/var/www/site/

A minimal page (content/hello.md):

---
title: Hello, world
date: 2026-09-13
---

# Hello, world

Your content here.

Status

Pre-1.0 and feature-complete for the milestone: new, dev, build, check, preview, clean, doctor, serve, and version all work. crystal spec, crystal tool format --check, and shards build --release are green in CI on Crystal 1.21 and latest. See roadmap.md for the v1.0 checklist.

Development

Requires Crystal >= 1.21.0.

shards install
shards build          # debug binary -> bin/plombir
crystal spec          # full test suite, must stay green
crystal tool format   # format sources before every commit

CI runs shards install --frozen, crystal tool format --check, crystal spec --error-on-warnings, and shards build --release on Crystal 1.21 and latest.

Documentation

• docs/getting-started.md: first site in under five minutes.
• docs/installation.md: build from source, dev setup.
• docs/project-structure.md: generated tree and conventions.
• docs/cli.md: every command, flag, and exit code.
• docs/content.md: collections, frontmatter, permalinks, schemas, check.
• docs/markdown.md: supported Markdown subset.
• docs/layouts.md: layouts, inheritance, includes, components.
• docs/config.md: every plombir.yml key and default.
• docs/deployment.md: ship dist/ to any static host.
• docs/troubleshooting.md: every common error and its fix.
• docs/templates.md: template language, filters, components, error gallery.
• docs/assets.md: assets/ vs public/, fingerprinting.
• docs/seo.md: meta tags, sitemap, feeds.
• docs/benchmarks.md: measured timings and budgets.
• roadmap.md: what gets built, in what order, and what "done" means.
• agents.md: how to work in this repo (commands, style, tests, PR rules).
• docs/adr/: architecture decision records.

License

MPL-2.0, see LICENSE.

Contributors

• Subhan Gadirli - creator and maintainer