Skip to content

bladeacer/flexcyon

Repository files navigation

Min App Version


Dark mode theme thumbnail
Light mode theme thumbnail

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.

Screenshots

Figure 1: ASCII Art, Dimmed File Extensions Figure 2: Vim Status Mode, Coloured Headings, Hide Until Hover Status Bar
Figure 3: Dimmed Inactive Settings navigation, smiley and coloured icons Figure 5: ASCII checkboxes
Figure 4: Light Mode with Powerlevel10k layout and status style

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

Documentation

A huge thanks to GitHub Pages for hosting the documentation at https://flexcyon.github.io/docs-en/

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

Features

Here is a web showcase of the features this theme has to offer.

  • Some features will not have a 1 to 1 correspondence to the main theme, but this site should give you a preview of how the theme looks before installing it

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

The following plugins/snippets are officially supported

Plugins
Snippets

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

Roadmap

The Roadmap for this theme can be found here.

Changelogs

The Changelogs for this theme can be found here.

Questions, Issues?

Feel free to talk about it at:

Alternatively, you can open an issue at the repository or start a GitHub discussion here.

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

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.

About

An Obsidian.md theme combining the colour schemes of Halcyon and Flexoki

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project