Skip to main content

Catppuccin theme extension for Zensical

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

catppuccin_zensical-0.2.1.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

catppuccin_zensical-0.2.1-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file catppuccin_zensical-0.2.1.tar.gz.

File metadata

  • Download URL: catppuccin_zensical-0.2.1.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for catppuccin_zensical-0.2.1.tar.gz
Algorithm Hash digest
SHA256 b9e595ab76b47729d00d16c0e6f9e8cdcf766ad8607ed695024f17bad332de85
MD5 ef43899cfb97d42b86aa64232eaacfc8
BLAKE2b-256 c138840af76840ceb1cea3001b849d8c0f968597cc32bd7071f5a7b77d0c7237

See more details on using hashes here.

File details

Details for the file catppuccin_zensical-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: catppuccin_zensical-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 7.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for catppuccin_zensical-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4a0208518b22515c9548130bd1da3cc56681644e2d9d640944db2fa6b036ee65
MD5 46c1fbb5fe71743dc8c799969a17e102
BLAKE2b-256 9a3972759b39e07e2d4e2381aba55045bcdfcfefdbb06c2e0ad37850176d1cf4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page