Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/catppuccin/obsidian

πŸ’Ž Soothing pastel theme for Obsidian
https://github.com/catppuccin/obsidian

catppuccin fancy hacktoberfest obsidian-md obsidian-theme obsidian-vault obsidianmd pastel-colors

Last synced: about 1 month ago
JSON representation

πŸ’Ž Soothing pastel theme for Obsidian

Awesome Lists containing this project

README

        


Logo


Catppuccin for Obsidian


GitHub star count
Open issues on GitHub
List of contributors


Example of the Catppuccin theme for Obsidian

+ [Previews](#previews)
+ [About](#about)
+ [Usage](#usage)
+ [Obsidian theme store](#obsidian-theme-store)
+ [Style Settings plugin installation and use](#style-settings-plugin-installation-and-use)
+ [Problems?](#problems)
+ [Contributing](#contributing)
+ [Plugins](#plugins)
+ [Development](#development)
+ [πŸ’ Thanks to](#-thanks-to)

## Previews

🌻 Latte
Preview of Latte theme

πŸͺ΄ FrappΓ©
Preview of FrappΓ© theme

🌺 Macchiato
Preview of Macchiato theme

🌿 Mocha
Preview of Mocha theme

## About

This is the Catppuccin theme for the note-taking app Obsidian.
The theme is a constant work in progress, given the quick
development pace of Obsidian itself and the user-made plugin
scene. The theme uses a base64-encoded version of Friedrich Althausen's font [Vollkorn](http://vollkorn-typeface.com) as its default editor text.
Runner up in πŸŽ‰ [Obsidian's 2022 Gems of the Year](https://forum.obsidian.md/t/gems-of-the-year-2022-winners/54903)
awards. Thank you to everyone who voted.

## Usage

This theme provides the full range of Catppuccin palettes when
used with the
[Style Settings](https://github.com/mgmeyers/obsidian-style-settings#obsidian-style-settings-plugin)
plugin
(see [here](https://help.obsidian.md/Extending+Obsidian/Community+plugins)
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](https://github.com/pitoniak32):

> To install Style Settings, open Obsidian's `Preferences`, and navigate to the
> OPTIONS section, select `Community plugins` and ensure that `Restricted Mode` is
> off.
>
> Now you can search
> for "[Style Settings](https://github.com/mgmeyers/obsidian-style-settings#obsidian-style-settings-plugin)"
> by mgmeyers.
> Once you have the plugin installed, you should be able to see a heading
> entry `Style Settings` on the left under `COMMUNITY PLUGINS` in
> the `Preferences` 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](https://github.com/catppuccin/obsidian/issues).
While there is
a [Discord community](https://discord.com/channels/907385605422448742/1027435548165558303)
for the theme, using GitHub Issues is good for the development
process, [less ephemeral](https://karl-voit.at/2020/10/23/avoid-web-forums/),
and helps other users who need support or want to contribute.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## Plugins

The theme currently has limited CSS for a few plugins
in [_plugins.scss](https://github.com/catppuccin/obsidian/blob/main/scss/vendors/_plugins.scss).
These include:

+ Another Quick Switcher
+ Better Command Palette
+ Obsidian Git
+ Omnisearch
+ MAKE.md

## Development

See
the [Releases](https://github.com/catppuccin/obsidian/releases)
page for the latest news.

## πŸ’ Thanks to

+ [mbeckrich](https://github.com/mbeckrich)
+ [AnubisNekhet](https://github.com/anubisnekhet)
+ [pitoniak32](https://github.com/pitoniak32)
+ [hiimsergey](https://github.com/hiimsergey)
+ [GabeVilela](https://github.com/GabeVilela)
+ [Aidavdw](https://github.com/Aidavdw)
+ The talented and kindhearted people in the Obsidian discord's
CSS channel. In particular:
+ [Chetachi](https://github.com/chetachiezikeuzor/Yin-and-Yang-Theme/)
+ [Kepano](https://github.com/kepano/obsidian-minimal)
+ [mgmeyers](https://github.com/mgmeyers/obsidian-california-coast-theme)
+ [jdanielmourao](https://github.com/jdanielmourao/obsidian-sanctum)

Β 

Cat sitting on gray line


Copyright Β© 2021-present Catppuccin Org

MIT license