Bifrost Zensical

Intility's Bifrost design system as a Zensical theme.

Description

A pip-installable Zensical theme that applies Intility's Bifrost design system.

Migrating from intility-bifrost-mkdocs? See the migration guide.

Installation

Start from the bifrost-zensical-template for a preconfigured project, or add the theme to an existing one:

uv pip install intility-bifrost-zensical

Usage

Set theme.name to intility-bifrost in zensical.toml (or mkdocs.yml):

[project.theme]
name = "intility-bifrost"

A theme cannot inject markdown extensions, so add those yourself. The Quick Start has the complete block plus color, version badge, and navigation options.

What it provides

• Bifrost design system - Colors and component styling, with light/dark mode that follows the system preference
• Theme colors - teal (default), green, purple, pink, yellow (set extra.primary)
• Typography - Satoshi for all text, JetBrains Mono for code (both self-hosted, no Google Fonts)
• Version badge - Set extra.version to show a Bifrost-styled version badge in the header
• A Bifrost table extension - intility_bifrost_zensical.table_ext, add to markdown_extensions for .bf-table styling

Local development

This project uses mise for tooling and just as a task runner:

mise install   # installs uv, Python, Node, just and lefthook
just setup     # syncs dev dependencies and installs git hooks
just dev       # serve the docs site locally

Run just to see all available recipes. The demo site at docs/index.md uses the theme directly. See CONTRIBUTING.md for the full workflow.