|
15 | 15 | <img src="https://github.com/catppuccin/obsidian/blob/main/assets/screenshot.png"/>
|
16 | 16 | </p>
|
17 | 17 |
|
18 |
| -## Temporary note: Obsidian 0.16.0 and Catppuccin |
19 |
| - |
20 |
| -Please see https://github.com/catppuccin/obsidian/issues/16#issue-1354963436 for information about how the current insider build and upcoming public release of Obsidian 0.16.0 will affect the Catppuccin theme. tl;dr, the theme will be considered deprecated in 0.16.0 until it is updated to work with the app's new default theme. In the meantime, if you are an insider and want to keep using Catppuccin, turn off insider builds to stay on 0.15.9. (But I think the new default theme is worth the update for insiders!) I will be working on getting Catppuccin 0.16.0 compliant and hopefully finished by the time of public release. |
21 |
| - |
22 | 18 | ## About
|
23 | 19 |
|
24 |
| -This theme covers my use case for the app. That said! Part of what makes Obsidian so fantastic is its many features and extended universe of user-created plugins. As time goes on, I would like to add more compatibility between the theme and some of the more popular plugins. Additionally, Obsidian now has a legacy editor. There be dragons, but none too bad: Most of the css was written before the new editor's beta. Currently the theme uses some css from [Kepano's Hider](https://github.com/kepano/obsidian-hider) plugin. That will change soon, but you may need to do some cmd/ctrl+p-ing in the meantime if you are used to buttons. (: |
| 20 | +This is the initial version of the Catppuccin theme for version 1.0.0 of Obsidian. The Obsidian update came with big changes to the program's UI, so this theme is still a work in progress, with many tweaks and improvements to come. |
25 | 21 |
|
26 | 22 | ## Usage
|
| 23 | +This theme currently benefits most when used with the [Style Settings](https://github.com/mgmeyers/obsidian-style-settings#obsidian-style-settings-plugin) plugin. This plugin will allow users to pick from several variations of the Catppuccin theme, including accents for each color in the palette and one that features a broader selection of Catppuccin colors (the default). In time, more options will be exposed through the Style Settings plugin so that users can pick and choose what colors of the palette they prefer. |
27 | 24 |
|
28 | 25 | ### Obsidian theme store
|
29 | 26 |
|
30 | 27 | To install from the Obsidian theme store:
|
31 | 28 | Open Obisidian 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.
|
32 | 29 |
|
33 |
| -### Manual |
34 |
| - |
35 |
| -1. Download the [catppuccin.css](https://github.com/mbeckrich/obsidian/blob/main/obsidian.css) file |
36 |
| -2. Put it under your Vault's configuration folder (e.g. `<vault>/.obsidian/themes/`) |
37 |
| -3. Open Obisidian and go to `Preferences` >> `Appearance` >> `Manage` |
38 |
| -4. Select `Catppuccin` |
39 |
| - |
40 | 30 | ## Development
|
41 | 31 |
|
42 | 32 | See the [Releases](https://github.com/catppuccin/obsidian/releases) page for the latest news.
|
43 | 33 |
|
44 |
| -### The shape of things to come |
45 |
| - |
46 |
| -+ [x] Style Settings plugin compatibility |
47 |
| -+ [x] Behind the scenes cleanup of scss/css |
48 |
| -+ [ ] Tweaks to improve theme consistency throughout UI |
49 |
| -+ [ ] Mobile version |
| 34 | +Please be aware that, due to the newness of the theme, there may be use cases I've not considered or inconsistencies I haven't yet noticed. If you find a problem, please open an issue. |
50 | 35 |
|
51 |
| -PRs and constructive feedback more than welcome. |
| 36 | +Finally, as of the 0.2.0 release of this theme, the CSS is ugly to look at and disorganized. So, pardon the mess, but it will be cleaned up -- promise! |
52 | 37 |
|
53 | 38 | ## 💝 Thanks to
|
54 | 39 |
|
55 | 40 | + [mbeckrich](https://github.com/mbeckrich)
|
| 41 | ++ [AnubisNekhet](https://github.com/anubisnekhet) |
56 | 42 | + The talented and kindhearted people in the Obsidian discord's CSS channel. In particular:
|
57 | 43 | + [Chetachi](https://github.com/chetachiezikeuzor/Yin-and-Yang-Theme/)
|
58 | 44 | + [Kepano](https://github.com/kepano/obsidian-minimal)
|
|
0 commit comments