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.2.tar.gz (5.6 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.2-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: catppuccin_zensical-0.2.2.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","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.2.tar.gz
Algorithm Hash digest
SHA256 9e29400a71ecc17fd4243022edc87d6ebc2ef072a556bc95681092aa357afeb9
MD5 575acf82ef7ebf692fda638c931c1be4
BLAKE2b-256 7e0314966b6ef2dde03818863f79b5b5173844816e594864a6838271a431b48a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: catppuccin_zensical-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.15 {"installer":{"name":"uv","version":"0.11.15","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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 403c736065771c7bfe923ef0bb769bfb01130501bf2af36c142a3807a3c1d4a2
MD5 cb7f0fc6ae3856750a9170b07699b717
BLAKE2b-256 691ce389b1558f26a87c38c97c68e061d3cda1532776fa62e8543785f9cbf676

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