Awesome
<h3 align="center"> <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/logos/exports/1544x1544_circle.png" width="100" alt="Logo"/><br/> <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px" alt=""/> Catppuccin for <a href="https://obsidian.md">Obsidian</a> <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px" alt=""/> </h3> <p align="center"> <a href="https://github.com/catppuccin/obsidian/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/obsidian?colorA=363a4f&colorB=b7bdf8&style=for-the-badge" alt="GitHub star count"></a> <a href="https://github.com/catppuccin/obsidian/issues"><img src="https://img.shields.io/github/issues/catppuccin/obsidian?colorA=363a4f&colorB=f5a97f&style=for-the-badge" alt="Open issues on GitHub"></a> <a href="https://github.com/catppuccin/obsidian/contributors"><img src="https://img.shields.io/github/contributors/catppuccin/obsidian?colorA=363a4f&colorB=a6da95&style=for-the-badge" alt="List of contributors"></a> </p> <p align="center"> <img src="https://raw.githubusercontent.com/catppuccin/obsidian/main/assets/screenshot-hq.png" alt="Example of the Catppuccin theme for Obsidian"/> </p>Previews
<details> <summary>🌻 Latte</summary> <img src="https://raw.githubusercontent.com/catppuccin/obsidian/main/assets/raw-flavor-screenshots/latte.webp" alt="Preview of Latte theme"/> </details> <details> <summary>🪴 Frappé</summary> <img src="https://raw.githubusercontent.com/catppuccin/obsidian/main/assets/raw-flavor-screenshots/frappe.webp" alt="Preview of Frappé theme"/> </details> <details> <summary>🌺 Macchiato</summary> <img src="https://raw.githubusercontent.com/catppuccin/obsidian/main/assets/raw-flavor-screenshots/macchiato.webp" alt="Preview of Macchiato theme"/> </details> <details> <summary>🌿 Mocha</summary> <img src="https://raw.githubusercontent.com/catppuccin/obsidian/main/assets/raw-flavor-screenshots/mocha.webp" alt="Preview of Mocha theme"/> </details>Usage
[!NOTE]
The theme is a constant work in progress, given the quick development pace of Obsidian itself and the user-made plugin scene. Currently, the default editor text uses a base64-encoded version of Friedrich Althausen's font Vollkorn.The theme was also a runner up in 🎉 Obsidian's 2022 Gems of the Year awards. Thank you to everyone who voted.
This theme provides the full range of Catppuccin palettes when used with the Style Settings plugin (see here for more on using plugins with Obsidian).
This plugin will allow users to pick from several variations on Catppuccin, including accents for each color in the palette and one that features the full host of Catppuccin colors (the default). New options will be exposed through the Style Settings plugin over time.
Obsidian theme store
To install from the Obsidian theme store:
Open Obsidian and go to Preferences
>> Appearance
,
click Manage
and scroll down to 'Community Themes.' Type '
Catppuccin' in the filter bar and then click 'Use' under the
theme name.
To use Catppuccin Latte, set the Base color scheme
option to Light
.
For one of the three dark themes, set Base color scheme
to Dark
.
This defaults to Catppuccin Mocha; install Style Settings as described below to change your dark theme flavor to Frappé or Macchiato.
Style Settings plugin installation and use
A note on Style Settings setup from pitoniak32:
To install Style Settings, open Obsidian's
Preferences
, and navigate to the OPTIONS section, selectCommunity plugins
and ensure thatRestricted Mode
is off.Now you can search for "Style Settings" by mgmeyers. Once you have the plugin installed, you should be able to see a heading entry
Style Settings
on the left underCOMMUNITY PLUGINS
in thePreferences
window.From there you can select, and configure your Catppuccin flavor, and make customizations :)
Problems?
Obsidian is a large and constantly expanding app with a variety of use cases and plugins. If you run into theme-related issues or want CSS adjustments made for your favorite plugin(s), please open an issue. While there is a Discord community for the theme, using GitHub Issues is good for the development process, less ephemeral, and helps other users who need support or want to contribute.
Contributing
See CONTRIBUTING.md.
Plugins
The theme currently has limited CSS for a few plugins in _plugins.scss. These include:
- Another Quick Switcher
- Better Command Palette
- Obsidian Git
- Omnisearch
- MAKE.md
Development
See the Releases page for the latest news.
💝 Thanks to
- mbeckrich
- AnubisNekhet
- pitoniak32
- hiimsergey
- GabeVilela
- Aidavdw
- The talented and kindhearted people in the Obsidian discord's CSS channel. In particular:
<p align="center"><img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" alt="Cat sitting on gray line"/></p> <p align="center">Copyright © 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a> <p align="center"><a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=363a4f&colorB=b7bdf8" alt="MIT license"/></a></p>