damiankorcz/Prism-Theme damiankorcz/Prism-Theme

  • Stars
    star
    346
  • Rank 122,430 (Top 3 %)
  • Language SCSS
  • License
    MIT License
  • Created about 3 years ago
  • Updated 8 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
damiankorcz/Prism-Theme
github

damiankorcz

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A Comprehensive, Highly-Customisable and Elegant Light/Dark Theme for Obsidian.md

Main Screenshot




✨ Key Features

πŸ’― Complete Platform Support

Platforms

Prism is designed to work across all platforms and operating systems Obsidian is available on (Desktop, Phone and Tablet).

β˜€οΈ 5 Light Colour Schemes

Light Colour Schemes

(Front to Back: Swan, Latte, Periwinkle, Pistachio and Peach)

πŸŒ‘ 5 Dark Colour Schemes

Dark Colour Schemes

(Front to Back: Raven, Mocha, Indigo, Pine and Cherry)

πŸ“š 3 Colour Scheme Styles

Colour Scheme Styles

(Left to Right: Minimal, Border and Two Tone & Border)

🌈 5 Accent Styles and 10 Preset Colours + Option for Custom Colours

Accent Styles and Colours

(Top Row: Accent Styles, Last 2 Rows: Available Colours + Custom Option)

πŸ“‘ Highlight System based on theΒ <mark>Β tag

The Highlight System comes with 4 different styles and an option to change the text colour independently from the other adjustments.
Usage examples and explanation available in the Wiki Guide.

Mark Highlight Styles and Colours

(Start to Finish: None, Border, Filled, Border & Filled, Text Colour option)

🧰 Customisation Options

Options for position, alignment, modification of various elements and plenty more available via the Style Settings plugin!

Style Settings

πŸš€ Getting Started

βš’οΈ Install the Style Settings Plugin (⚠️ Required)

  1. Open Obsidian and go to Settings.
  2. Click on the Community plugins tab.
  3. Click on the Browse button.
  4. In the Search community plugins... Search Box, search for Style Settings.
  5. Click the Install button.
  6. Click the Enable button once the plugin is finished installing.

πŸ’Ž Install the Prism Theme

  1. Open Obsidian and go to Settings.
  2. Click on the Appearance tab.
  3. Click the Manage button.
  4. In the Filter... Search Box, search for Prism.
  5. Click the Install and use button.

I highly recommend for you to go through the options available in the Style Settings to make the theme fit you just right!

🧩 Supported Plugins

Checkout the full list in the Supported Plugins section of the Wiki. These plugins have been checked to work correctly and might have additional settings in Style Settings.

If you have any issues with the plugins mentioned above or would like another plugin to be supported by the theme Submit an Issue regarding it.

βœ‚οΈ Snippets

Theme features which you can import as snippets into Obsidian are located in the Snippets Folder. These features have been requested by users for use in other themes and for additional interoperability between themes.

πŸ“– Wiki

The theme has a Wiki which includes additional detailed descriptions for theme specific features and customisation options.

πŸ—ΊοΈ Theme Roadmap

To track all the features I have planned, actively working on and what is coming in the next release take a look at the Prism Theme Roadmap.

πŸ›  Contributing

Currently the theme is being designed for desktop and mobile use (Phone and Tablet). The theme has been tested on Windows 11 and Android Phone/Tablet.

If you want to provide specific feedback or report an issue please use Issues.

Although I don't prohibit pull requests, the theme is quite complex with a lot of intricate setup to keep in mind when adding features. I'd recommend submitting an Issue if you encounter any. I'll try my best to stay on top of the most pressing ones!

Otherwise you are welcome to contact me through the channels mentioned below to discuss anything regarding the theme.

πŸ“¬ Contact

Feel free to reach out to me via the Official Obsidian Discord Channel:

Discord

Let me know how you use the theme over at Prism's Obsidian Forum Thread:

πŸ“£ Acknowledgments

Special thanks to the following people:

  • The developers of Obsidian.md for providing an amazing tool free of charge!
  • @mgmeyers for Style Settings and Kanban Plugins that are the backbone of this theme! Also thank you for addressing some issues I've encountered with Style Settings while developing the theme.
  • @chrisgrieser for the Hue slider gradient code.
  • @tingmelvin for helping me debug issues.
  • On recommendation from @valentine195 - Esbuild config was originally based on @jdanielmourao's Sanctum theme setup.
  • The Obsidian Community over at Discord for endless inspiration to improve the theme!

πŸ“ License

The Theme contains Base64 embedded versions of the following fonts:

The default Vault Banner Icon Opened Folder icon has been sourced from Icons8.

The Theme code is distributed under the MIT License. See LICENCE for more information.