Skip to content

The Halcyon colour scheme by Brittany Chiang, ported to be used in Obsidian.

License

Notifications You must be signed in to change notification settings

dbarenholz/halcyon-obsidian

Repository files navigation

Halcyon for Obsidian

banner-image

I fell in love with the Halcyon colour scheme, so I decided to port it to my favourite notetaking app, Obsidian. Halcyon is dark-mode only.

Installation

You can install Halcyon through Obsidian, or manually.

Through Obsidian (Recommended)

  1. Go to settings > appearance.
  2. Click Manage next to Themes.
  3. Search for Halcyon.
  4. Click Install and use.
  5. Enjoy using my favourite theme! 🥳

Manual

Note: manually installed themes do not get updated automatically. You should prefer installing through obsidian if possible.

  1. Download the latest release as ZIP file.
  2. Extract the folder into your vault's .obsidian/themes folder.
  3. Go to settings > appearance.
  4. Select Halcyon from the dropdown list.
  5. Enjoy using my favourite theme! 🥳

Plugin Support

  • Chetachi's Highlightr plugin: when selecting css-classes as option, it will by default use the Halcyon colors for its highlights.

Known Issues

There are a few limitations that are outside of my control as theme developer. Here's a list of them.

  • Putting a codeblock (```language) inside a quote > is not recognized by the underlying parser.
  • We cannot style a dataviewjs codeblock from the Dataview plugin the same way as normal js, because the underlying parser doesn't recognize it as javascript.

Did you find more issues? Let me know by making an issue!

Style Settings

As of version 0.0.4 there is now a basic support for style settings. This version is still work in progress and unreleased, but the code has been pushed to git.

License

This theme is released under the MIT License.

Credits and Acknowledgments

This theme would never have seen its conception, if not for the following people:

  • Brittany Chiang, for creating the Halcyon theme with a permissive license (MIT)!
  • Discord user sailKite, for surprising me with a first version of the theme out of the blue. Thank you!
  • Many members of the OMG discord who have gone through many dark magics to help me fix my selectors and issues I had while creating the theme.

Changelog

Version 0.0.4 (work in progress):

  • Add rudimentary Style Settings support.

Version 0.0.3:

  • Fix inaccurate HSL variables; this was the cause for #4.
  • Fix cascading issues from inaccurate HSL variables.

Version 0.0.2:

  • Fix: Hovering headers in tables that are in a callout. See #3.

Version 0.0.1:

  • Github repository has been made public.