Skip to content

jonathan343/catppuccin-zensical

Repository files navigation

Catppuccin Zensical

Version Supported Python Versions Documentation License

A Catppuccin theme extension for Zensical and MkDocs sites.

It registers an installable theme named catppuccin that extends Zensical's Material-compatible theme with Catppuccin's Latte, Frappé, Macchiato, and Mocha palettes.

Live demo · Showcase · Configuration · Changelog

Catppuccin Zensical preview showing Mocha, Macchiato, Frappé, and Latte

What you get

  • Four Catppuccin flavors: Latte, Frappé, Macchiato, and Mocha.
  • Automatic light/dark mode defaults: Latte for light mode and Mocha for dark mode.
  • Catppuccin colors across Zensical components, including navigation, search, code blocks, admonitions, tables, highlights, diagrams, and footer elements.
  • A small optional "Styled with catppuccin-zensical" footer signature that links back to the live documentation.

Quick start

Install the package in the same environment as Zensical:

uv pip install catppuccin-zensical

Then set the theme name in zensical.toml:

[project.theme]
name = "catppuccin"

Or in mkdocs.yml:

theme:
  name: catppuccin

Choose a flavor

The default configuration follows the user's system preference with Latte for light mode and Mocha for dark mode. To force a specific flavor, set the palette scheme:

theme:
  name: catppuccin
  palette:
    scheme: catppuccin-macchiato
    primary: custom
    accent: custom

Available schemes:

Flavor Scheme
Latte catppuccin-latte
Frappé catppuccin-frappe
Macchiato catppuccin-macchiato
Mocha catppuccin-mocha

Footer signature

The theme adds a small "Styled with catppuccin-zensical" line to the footer that links to the live documentation. To opt out, set:

[project.extra.catppuccin]
signature = false

Or in mkdocs.yml:

extra:
  catppuccin:
    signature: false

Local development

From this checkout:

uv sync --all-groups
uv run zensical serve

About

Catppuccin theme extension for Zensical

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors