Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some information on the now deprecated schemeFromYAML and the currently archived base16-schemes repository #61

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+16 −2
Open

Add some information on the now deprecated schemeFromYAML and the currently archived base16-schemes repository #61

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1c0c070
updated information on base16
partisani Oct 10, 2024
ca80134
small fix
partisani Oct 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,8 @@ All of these are exposed at `nix-colors.lib`.
### `schemeFromYAML`

This function is used internally to convert base16's schemes to nix-colors
format, but is exposed so you can absolutely do the same.
format, but is exposed so you can absolutely do the same. Sadly, it was
deprecated.

Just grab (or create yours) a `.yaml` file, read it into a string (with
`readFile`, for example) and you're golden:
Expand All @@ -206,6 +207,16 @@ Just grab (or create yours) a `.yaml` file, read it into a string (with
This path can come from wherever nix can read, even another repo! That's what
we do to expose base16's schemes.

If you feel like the fact `schemeFromYAML` being deprecated is enough
for you to not use it, then just use `builtins.fromTOML` and a `.toml` file
instead.

Keep in mind this method will require you to convert the `.yaml` file
into a `.toml` one (and add a slug field), but comes with the advantage
that you will be able to use color schemes which weren't released in the
currently archived [base16-schemes](https://github.com/base16-project/base16-schemes) repo


### More soon(TM)

We plan on helping you turn existing base16 templates into nifty nix functions
Expand Down Expand Up @@ -236,7 +247,10 @@ in {
}
```

# Upstreaming new schemes
# ~~Upstreaming new schemes~~

<sub>only kept here for posterity, as the [base16-schemes](https://github.com/base16-project/base16-schemes)
repository was archived and `nix-colors` wasn't updated to use the new [schemes](https://github.com/tinted-theming/schemes) repo.<sub>

Please please upstream nice schemes you have created!

Expand Down