Skip to content

catppuccin/latex

Repository files navigation

Logo
Catppuccin for LaTeX

Previews

🌻 Latte
🪴 Frappé
🌺 Macchiato
🌿 Mocha

Usage

Importing the theme file

  1. The catppuccinPalette package is present on CTAN, but probably not included in your TeX Live installation. Follow the steps below to install it manually:
    • Shortcut: If you set up your local texmf you should be able to simply install by executing make install (this installs the package locally for the current user)
    • If you don't like installing the package locally for the current user you might also execue l3build unpack and move the generated .sty file build/unpacked/catppuccinpalette.sty to the root directory of your project.
    • If you don't have l3build available, you can also download the catppuccinpalette.sty file from the latest GitHub release and move the file to your project root.
  2. Import the package by adding \usepackage[FLAVOR]{catppuccinpalette}, replacing FLAVOR with the flavor of your choice. i.e. \usepackage[macchiato]{catppuccinpalette}. Valid options are: mocha (default), latte, frappe, and macchiato.
    • If you want the package not only to add color definitions, you can also pass textcolor=true and/or pagecolor=true to the catppuccinpalette package.
    • Also note that in the pdf containing the documentation, the available options are described in more detail and also the defined colors are listed and shown.

Color Naming Conventions

All Catppuccin palette colors, across all flavors, follow the same naming convention. This theme set prefixes all Catppuccin colors with Ctp, i.e. CtpPeach, or CtpBlue.

Support for special latex packages/classes

beamer

Catppuccinpalette also provides a colorscheme which can be loaded in latex beamer e.g. via \usecolortheme[style=Latte, accent=Blue]{catppuccin}

🪴 Frappé Example

hyperref

If you want to catppuccinpalette can redefine some colors hyperref uses for highlighting links according to the catppuccin style guide. For this you only need to pass hyperref=true to \usepackage{catppuccinpalette} (after hyperref has been loaded)

Examples

Please refer to the examples for full demonstrations, with LaTeX sources and their outputs, on theme usage and code highlighting.

Developing

How to do a new release
  1. adjust the version tag in the latex.tera and beamercolorthemecatppuccin.dtx files
  2. add the changelog entry also in those two files (I'd say we just skip the entry if for the specific package/file nothing was changed now that we have two packages/files)
  3. run make whiskers
  4. PR -> merge -> tag the commit (conforming to "v*.*.*" and the release will be created automatically)

💝 Thanks to

 

Copyright © 2021-present Catppuccin Org

Sponsor this project

  •  

Contributors 5

Languages