README file from
GithubNeoPpuccin
A theme for Obsidian
Note: NeoPpuccin is a relatively new project. It will take a couple of weeks for everything to be documented and set up as intended — thanks for your patience while things are finalized!
Note: Your AnuPpuccin settings are not transferred automatically. If you're migrating from AnuPpuccin, use the settings converter to convert your exported style settings (or open
tools/settings-converter.htmlfrom this repo directly).
NeoPpuccin is a fork of AnuPpuccin that aims to continue it's development with bug fixes, new features and more colorschemes.
NeoPpuccin is a theme for Obsidian that is designed to be minimalistic, clean and easy on the eyes. The theme supports various colorschemes (including Catppuccin), layouts and features that can be toggled on and off using the style settings plugin.
Features
By default the theme provides a close-to-vanilla Obsidian experience with the Catppuccin colorscheme, but it can be customized to your liking using the style settings plugin. The theme supports more colorschemes, different layouts and features that can be toggled on and off.
Colorschemes
The theme supports the following colorschemes:
- Atom
- Catppuccin (Latte, Frappe, Macchiato, Mocha, Mocha Old)
- Coffee
- Biscuit
- Everforest
- Dracula
- Gruvbox
- Nord (Nord Light, Nord Dark, Nord Darker)
- Notion
- Kanagawa
- Rosé Pine (Rosé Pine Dawn, Rosé Pine)
- Rosebox
- Royal Velvet
- Sandy Beaches
- Solarized
- thorns
- Generic (Dark, AMOLED Dark)
Layouts
NeoPpuccin currently supports 3 layout variants: Default, Borders and Cards.
Rainbow folders
Add a splash of color to your vault with the rainbow folders setting.
Alternate tabs
Customize your tabs style with the alternate tabs setting.
Customisable Decorations
Bold and italic colors can be toggled on and off and can be customised according to the palette as well.
Callouts
Custom checkboxes & Speech bubbles
When enabled, checkboxes can have more states than just checked and unchecked. The following table shows the available states and their syntax:
| Syntax | Description |
|---|---|
- [ ] |
Unchecked |
- [x] |
Checked |
- [>] |
Rescheduled |
- [<] |
Scheduled |
- [!] |
Important |
- [-] |
Cancelled |
- [/] |
In Progress |
- [?] |
Question |
- [*] |
Star |
- [n] |
Note |
- [l] |
Location |
- [i] |
Information |
- [I] |
Idea |
- [S] |
Amount |
- [p] |
Pro |
- [c] |
Con |
- [b] |
Bookmark |
- ["] |
Quote |
- [u] |
Up |
- [d] |
Down |
- [w] |
Win |
- [k] |
Key |
- [f] |
Fire |
- [0] |
Speech bubble 0 |
- [1] |
Speech bubble 1 |
- [2] |
Speech bubble 2 |
- [3] |
Speech bubble 3 |
- [4] |
Speech bubble 4 |
- [5] |
Speech bubble 5 |
- [6] |
Speech bubble 6 |
- [7] |
Speech bubble 7 |
- [8] |
Speech bubble 8 |
- [9] |
Speech bubble 9 |
Colorful Frame
Originally adapted from Kepano's Minimal theme, "colorful frame" add some pop to your vault by displaying your accent color Around the edges of the editor and preview panes. The accent color can be changed in the style settings.
Simplified markdown embeds
Markdown embeds have an alternate styling with an animated variant which can be toggled globally using style settings or individually using alt names for embeds, for example: ![[embed|alt-name]]
| Embed style | Alt name |
|---|---|
| Seamless | seamless |
Custom CSS Classes
Inserting these css classes into your note frontmatter will style your notes individually.
| CSS Class | Function |
|---|---|
heading-normal-toggle |
Disables color in headings |
decorations-normal-toggle |
Disables color in text decorations like bold and italic |
hide-metadata |
Hides metadata |
Installation
Normal Installation
Go to your theme folder (.obsidian/themes) and run:
git clone [email protected]:notnotnescap/NeoPpuccin.git
Updating
Go to your NeoPpuccin folder (.obsidian/themes/NeoPpuccin) and run:
git pull
Building
Clone the github repo and run sass src/base.scss theme.css (or make) in the root folder.
Colorschemes
| Theme | Light Mode | Dark Mode | Extra Notes |
|---|---|---|---|
| Atom | Yes | Yes | Accent value is hardcoded into the theme. |
| Catppuccin | Yes | Yes | There are 4 variants of the dark theme, namely: Frappe, Macchiato, Mocha and Mocha Old.The light theme is called Latte. |
| Coffee | No | Yes | Custom colorscheme |
| Biscuit | Yes | Yes | - |
| Everforest | Yes | Yes | - |
| Dracula | No | Yes | - |
| Gruvbox | Yes | Yes | - |
| Nord | Yes | Yes | A custom darker variant of the dark theme is included as well. Accent value is hardcoded into the theme. |
| Notion | Yes | Yes | - |
| Kanagawa | No | Yes | - |
| Rosé Pine | Yes | Yes | The second variant of the dark theme, namely Rosé Pine dawn hasn't been implemented yet. |
| Rosebox | No | Yes | Accent value is hardcoded into the theme. |
| Royal Velvet | No | Yes | - |
| Sandy Beaches | Yes | No | Provided by melnhh |
| Solarized | Yes | Yes | - |
| thorns | No | Yes | - |
Previews
Integrations
- Excalidraw
- Kanban
- Style Settings
Minimal Features
NeoPpuccin includes Minimal's Cards snippet, used under its MIT license with full style settings support. You can support Kepano here.
Recommended Fonts
- Interface: Overpass
- Text: Rubik
- Headings: Noto Serif
Contributions
As mentionned at the top, NeoPpuccin is a fork of AnuPpuccin maintained by AnubisNekhet. You may see the github page to see the original theme and its contributors. If you want to contribute to NeoPpuccin, please submit a pull request or open an issue on this repository.
If you like this theme
You can support me directly on my my Ko-Fi page. You can also support AnubisNekhet, the original author of AnuPpuccin, on his Buy Me a Coffee page.
License
NeoPpuccin is licensed under the GPL-3.0 license which allows you to modify the code freely, however the Copyright and license notices must be preserved in your CSS. If you redistribute a part of the code, please credit the theme in your CSS file.