flexcyon

About Flexcyon

A Obsidian theme combining the colour schemes of Halcyon and Flexoki.

I really liked the vibrant colours of the Halcyon colour scheme, and the inky aesthetic of the Flexoki colour scheme. Hence, I decided to combine the two which started this theme.

There is also a light mode colour scheme combining Origami theme's and Flexoki light's colour schemes.

Installation via community store (recommended)

To install this theme via the community store, navigate to Settings > Appearance

1. Under Themes, click Manage
2. Type "Flexcyon" in the search bar > Select it > Click "Install and Use"

Installation of Style Settings is highly recommended for this theme, as most customisation and functionality is built around it.

Installation via BRAT

To install this theme via BRAT, navigate to Settings > Community Plugins > Browse

1. Type "BRAT" in the search bar > Select it (the one by TftHacker) > Click install
2. Wait for installation to complete then click Enable
3. Click Options
4. Click Add Beta Theme
5. Input https://github.com/bladeacer/flexcyon and then click Add Theme

Supported versions

Flexcyon is officially supported from Obsidian Version 1.6.3 onwards.

More details in the documentation.

Documentation

Huge thanks to GitHub Pages for hosting the documentation.

如果您更熟悉中文, 请 单击此处 查看中文文档.

Korean documentation can be found here. It is maintained by @OneVth.

Migrating to Style Settings to 2.0

There has been a fair bit of structural changes to the theme's Style Settings.

Click here to see the 2.0 migration guide and use the migration tool.

If you do not wish to migrate your old settings, or you are only using the default settings; you can just upgrade the theme and click the reset button on all associated setting sections.

Design Principles

This theme tries to:

• be "reasonably opinionated"
  • Choose between the opinionated Flex Max mode
  • or customising the theme extensively
  • Opt into customisations you choose instead of opting out
• be decently lightweight, meaning:
  • fonts, svgs and the like are not embedded in this theme
  • (hopefully) sane defaults, customisable with style settings
• dim inactive or unfocused UI elements to reduce information overload
• have a decent feature set of style settings for customisation
• bundle numerous callout metadata utilites

Features

Refer to the documentation for the full set of features in Flexcyon.

What this theme has

• vim mode status (when using builtin vim keybinds)
• Status bar options like Powerlevel10k inspired status bar styling
• Smiley toggle icons and other options for settings
• ASCII art or custom quote in new empty tabs
• subtle opacity effects for UI elements
• a light and dark mode colour scheme
• ASCII checkboxes
• Heading options like underline, numbered, coloured
• A plethora of cssclasses and callout customisation options
• A plethora of cssclasses and callout customisation options
• Workspace Layouts like card layout with TUI inspired add-on, angled layout
• Configure left, right sidebar and modal background images
• Animation options for tabs
• And many more...

What this theme does not have

• multiple colour schemes (though you can override the existing one with your own, see Style Settings)
• alternate checkboxes
• embedded fonts, svgs

Supported plugins/snippets

View supported plugins and snippets here

For plugins/snippets that are not styled yet, feel free to open a Pull Request/Feature Request/start a Discussion on it.

Snippet collection

Some of the theme's snippets like ASCII Art and its callouts can be found here.

Questions, Issues?

Feel free to talk about it at:

• this Matrix Space
• this Obsidian forum topic
• this Discord thread
• start a GitHub discussion

Methods of communication are listed in order of preference.

Contributing

Refer to the documentation on contributing.

Style Settings

Documentation for style settings of this theme can be found here.

Documentation on installing and using style settings can be found here.

License

This theme is licensed under the MIT License.

Credits

Without these contributors and tools, flexcyon would not be possible.

The code of conduct was adopted from the Contributor Covenant.

The contributing guide was adopted from conduct.