Extensive Base16 and Base24 library for Nix.
Find a file
2024-09-14 03:22:44 +00:00
.github/workflows CI: run weekly 2024-05-11 04:38:46 +03:00
json CI: update JSON schemes 2024-09-14 03:22:44 +00:00
packages/convert-scheme Initial commit 2024-05-11 03:13:06 +03:00
default.nix add flake-compat 2024-05-11 04:54:22 +03:00
flake.lock flake: add missing flake-compat input 2024-08-26 20:36:50 +03:00
flake.nix flake: add missing flake-compat input 2024-08-26 20:36:50 +03:00
LICENSE Initial commit 2024-05-11 03:13:06 +03:00
README.md clean up readme 2024-08-26 20:43:57 +03:00

Basix

An over-engineered Nix flake for all Base16 and Base24 themes from tinted-theming/schemes, exposed as one convenient library.

How does it work?

For some obscure reason1 all schemes provided by tinted-theming is in YAML and under one unified repository. We convert each YAML scheme to JSON to ensure the schemes are in a format Nix can read, then read them and expose them under a flake output.

How do I use this?

Basix be used as a flake input, or imported from a tarball.

To get a color scheme, import either schemeData.base16 or schemeData.base24 from the outputs from this flake to import the color schemes for yourself.

nix-repl> :p schemeData.base16.decaf
{
  author = "Alex Mirrington (https://github.com/alexmirrington)";
  name = "Decaf";
  palette = {
    base00 = "2d2d2d";
    base01 = "393939";
    base02 = "515151";
    base03 = "777777";
    base04 = "b4b7b4";
    base05 = "cccccc";
    base06 = "e0e0e0";
    base07 = "ffffff";
    base08 = "ff7f7b";
    base09 = "ffbf70";
    base0A = "ffd67c";
    base0B = "beda78";
    base0C = "bed6ff";
    base0D = "90bee1";
    base0E = "efb3f7";
    base0F = "ff93b3";
  };
  system = "base16";
  variant = "dark";
}

Why?

There are not many theming solutions for Nix. Those that already exist are either too convoluted, or straight up bad in terms of code quality or/and execution. This leads me to use (and recommend) home-baked theming modules for in-home usage, but there was not a good Base16 solution on Nix. Basix aims to solve this issue by providing you an auto-updated collection of Base16 and Base24 color palettes. As opposed to traditional hacks needed to convert YAML to JSON and then read it, you can simply consume attribute sets derived from JSON schemes while Basix does the heavy lifting for you.

Basix might come in handy in scenarios you wish to theme individual applications from a pre-defined color palette.

Credits

License

Licensed under the GNU General Public License v3.0.


  1. I'm being generous here. The obscure reason is the myth that YAML is human readable. Guess what? It is actually nowhere near human readable and you should avoid it ↩︎