Metadata-Version: 2.4
Name: catppuccin-zensical
Version: 0.2.2
Summary: Catppuccin theme extension for Zensical
Keywords: catppuccin,documentation,material-for-mkdocs,mkdocs,theme,zensical
Author: jonathan343
Author-email: jonathan343 <jonathangee09@gmail.com>
License-Expression: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Documentation
Requires-Dist: zensical>=0.0.37
Requires-Python: >=3.10
Project-URL: Changelog, https://github.com/jonathan343/catppuccin-zensical/blob/main/CHANGELOG.md
Project-URL: Code, https://github.com/jonathan343/catppuccin-zensical
Project-URL: Documentation, https://jonathan343.github.io/catppuccin-zensical/
Project-URL: Issue tracker, https://github.com/jonathan343/catppuccin-zensical/issues
Description-Content-Type: text/markdown

# Catppuccin Zensical

[![Version](https://img.shields.io/pypi/v/catppuccin-zensical.svg)](https://pypi.org/project/catppuccin-zensical/)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/catppuccin-zensical.svg)](https://pypi.org/project/catppuccin-zensical/)
[![Documentation](https://img.shields.io/github/deployments/jonathan343/catppuccin-zensical/github-pages?label=docs)](https://jonathan343.github.io/catppuccin-zensical/)
[![License](https://img.shields.io/github/license/jonathan343/catppuccin-zensical)](LICENSE)

A [Catppuccin](https://catppuccin.com/) theme extension for
[Zensical](https://zensical.org/) 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](https://jonathan343.github.io/catppuccin-zensical/) ·
[Showcase](https://jonathan343.github.io/catppuccin-zensical/showcase/) ·
[Configuration](https://jonathan343.github.io/catppuccin-zensical/configuration/) ·
[Changelog](https://jonathan343.github.io/catppuccin-zensical/changelog/)

![Catppuccin Zensical preview showing Mocha, Macchiato, Frappé, and Latte](docs/assets/readme-preview.png)

## 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:

```sh
uv pip install catppuccin-zensical
```

Then set the theme name in `zensical.toml`:

```toml
[project.theme]
name = "catppuccin"
```

Or in `mkdocs.yml`:

```yaml
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:

```yaml
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:

```toml
[project.extra.catppuccin]
signature = false
```

Or in `mkdocs.yml`:

```yaml
extra:
  catppuccin:
    signature: false
```

## Local development

From this checkout:

```sh
uv sync --all-groups
uv run zensical serve
```
