/willemstad-x

A fully-fledged Obsidian.md theme, evolved from the original theme variant for Chris Grieser (pseudometa)'s theme Shimmering Focus

Primary LanguageSCSSMozilla Public License 2.0MPL-2.0

wx-github-2-mini

Please note: Willemstad is currently undergoing a rewrite (from ground-up) for Obsidian 1.0, and the look and feel might be somewhat materially different from now. The UI from current alpha-version available in the Community Store right now will remain.

The theme documentation is available here.

Willemstad X (Extended)

Named after the capital of Curaçao (which is known for its colourful houses), the extended Willemstad is a fully-fledged theme and extension of the original Willemstad snippet/theme variant proof-of-concept for Chris Grieser (pseudometa)'s Obsidian theme, Shimmering Focus. You can sponsor Chris here!

NOTE! Willemstad X is not supported for the legacy editor (CodeMirror 5), or for mobile. While mobile support might be coming in the longer future, you are advised only to use Willemstad X on desktop, and in the current default editor.

To use:

For the most current version, use the Community Theme store in Obsidian. (this is the preferred and recommended method!)

Alternatively, download the release, and drop obsidian.css into your .obsidian\themes folder in the vault you wish to have the theme in.


Why is Inter embedded into Willemstad X, isn't that included in Obsidian proper?

Yes, it is. Inter is included in Obsidian proper. However, most people will download Inter onto their computers, and Obsidian will use the font with the name that is present in your computer. Moreover, most people (including myself) download/-s/-ed Inter from Google Fonts, which is probably the most outdated version you can get of the font. (No proper italics, need I say more?!) By embedding Inter, alongside the other fonts, allows me to quality control and ensure the quality of your experience.

I'd like to change something or propose something. What's the easiest way to do so?

If it's something you reckon people would need/want as well, the easiest way to request changes is to use the Issues tab here on GitHub. If you would like to change something that you can reckon you rather do it yourself, the best way would be to use a snippet.

Alternatively, and if you are familiar with Sass/SCSS, you can compile Willemstad yourself via the files in the build folder, and fork the repo and edit the relevant files you want to. To understand what each specific SCSS file consists of, consult here. This might be slightly outdated.


Supported Community Plugins

Please refer to the Willemstad theme documentation.

The full list of supported community plugins can be found here.

Attribution

As is with most theme codes in Obsidian, many pieces/snippets of code have been cobbled together from whatever the hive mind has created. It is therefore not possible to accurately and fully attribute everyone's efforts, which might have come into and been adopted by this theme. That being said, there are multiple pieces of instrumental code that I can attribute to, which I do so here:

Theme Documentation (currently a work in progress)

Available here, includes information on callouts.

Mentions in the Obsidian Roundup

4th June | 14th May | 23rd April | 16th April | 04th April | 26th March | 12th March | 5th March | 26th February | 19th February

and of the original Willemstad snippet for Shimmering Focus: 12th February and 5th February

Just another word

Having a theme out within 2.5 weeks of trying to do something with CSS (from the time I left Sanctum, which I honestly think jdaniel did an amazing job with) is probably something I didn't think was possible even a week before this was published. That being said, Chris (of Shimmering Focus fame), Cecilia (of Primary fame), and SlRvB (of ITS Theme fame) prophesied I would end up with a theme and had more faith in me than I did. I owe them a word of thanks. Thanks y'all, and I hope I didn't let anyone of you down. 😊


License

License: MPL 2.0 This repository is licensed under the terms of Mozilla Public License version 2.0. Most of its constituent snippets (callouts, CSSClass, etc.) are licensed under the terms of the MIT license, either by myself or its respective authors.