zensical-updates 0.1.3

Generate a dated Updates (blog) section for zensical sites as plain Markdown

zensical-updates

Generate a dated "Updates" (blog) section for zensical sites as plain Markdown. zensical ships no blog plugin, so this CLI runs as a pre-build step. It reads your post files and writes an index listing, per-year archives, and tag and category pages that zensical then builds.

How it works

Writers keep posts in a source directory (default updates/), one Markdown file per post. Each post carries a date and optional categories/tags in block-list front matter:

---
date: 2026-06-11
categories:
  - weekly-update
tags:
  - epf
---

# Hello world

The first paragraph becomes the listing excerpt.

zensical-updates build copies each post to docs/<base>/<slug>.md and writes the generated section around it (the index, archive/, tags/, categories/). A post at docs/updates/hello.md renders at /updates/hello/, and every generated link points there. Run it before zensical:

zensical-updates build              # writes docs/updates/
zensical build --clean --strict

The generated docs/<base>/ tree is build output. Gitignore it. The source tree stays under version control, and the generator never edits it.

Install

uv add zensical-updates
# or: pip install zensical-updates

Configure

Settings live in zensical.toml under [project.extra.zensical_updates], a namespace zensical ignores:

[project.extra.zensical_updates]
base = "updates"        # section dir under docs/ and the URL base
source = "updates"      # where your post files live, outside docs/
emit_tags = true
emit_categories = true
emit_archive = true

Every key is optional. The defaults above apply when the table is absent.

Feed

With site_url set in zensical.toml, the build writes an RSS 2.0 feed to docs/<base>/feed.xml, served at <site_url>/<base>/feed.xml (for the default section, /updates/feed.xml). Each item carries the full post HTML, rendered by zensical so it matches the site, with every link rewritten to a fully-qualified URL for readers off-site. Without site_url the build prints a warning and skips the feed, since an off-site feed needs absolute links.

Two config keys tune it:

[project.extra.zensical_updates]
emit_feed = true   # generate feed.xml (default)
feed_limit = 0     # max items, 0 means no cap (default)

CLI

zensical-updates build    # generate the section into docs/<base>/
zensical-updates clean    # remove the generated output
zensical-updates --help

Development

git clone https://github.com/IvanAnishchuk/zensical-updates.git
cd zensical-updates
uv sync

uv run pytest                       # tests + coverage (includes the zensical build)
uv run ruff check src/ tests/
uv run ruff format --check src/ tests/
uv run mypy
uv run pre-commit run --all-files

License

CC0-1.0. This is an original implementation inspired by the concept of knu2xs/zensical-blog, written from this project's own analysis of how zensical behaves.