summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMichael McClintock <mrmcc3@gmail.com>2023-01-16 10:58:39 +1000
committerMichael McClintock <mrmcc3@gmail.com>2023-01-16 10:58:39 +1000
commit415580a058fa3b6a7b030a72efc3ab5a79755fb0 (patch)
tree54aaeb3ae8c1a02f4d5f123265b33b852e174091 /README.md
parent18ee97f37bb57fbac6b82cd8417203a611e3c3c2 (diff)
downloadyo-theme-helix-415580a058fa3b6a7b030a72efc3ab5a79755fb0.tar.gz
format
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 16 insertions, 12 deletions
diff --git a/README.md b/README.md
index 7421613..e0a9f15 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,19 @@
# yo-theme-helix
-A [Helix][helix] theme inspired by [Zenbones][zenbones] & [Alabaster][alabaster]. Uses [Radix Colors][radix].
+A [Helix][helix] theme inspired by [Zenbones][zenbones] &
+[Alabaster][alabaster]. Uses [Radix Colors][radix].
### Notes
- Ideas from alabaster.
- Comments should stand out.
- Use color sparingly. The rules should be simple.
-- Alabaster essentially skips eveything else. It doesn't highlight keywords (reserved words) or types.
- (which to be fair isn't really an issue for clojure)
- - Yo doesn't go quite as far on this point.
- - Instead it takes the minimal zenbones approach to highlight the remaining code constructs.
+- Alabaster essentially skips eveything else. It doesn't highlight keywords
+ (reserved words) or types. (which to be fair isn't really an issue for
+ clojure)
+ - Yo doesn't go quite as far on this point.
+ - Instead it takes the minimal zenbones approach to highlight the remaining
+ code constructs.
- subtle colors, contrast & font variants
- vibrant colors are left for diagnostics.
- The default yo themes use the following:
@@ -19,14 +22,15 @@ A [Helix][helix] theme inspired by [Zenbones][zenbones] & [Alabaster][alabaster]
- **Blue** for comments (incl. LSP info/hints)
- **Red/Amber** LSP error/warnings
- **Gray/Bronze** Everything else zenbones style
-- I'm not a designer and don't like my chances of making something look good by tweaking colors so instead
-i'll let the pros handle it.
- - [Radix Colors][radix] are very well deisgned. with clear instructions for how to apply them.
+- I'm not a designer and don't like my chances of making something look good by
+ tweaking colors so instead i'll let the pros handle it.
+ - [Radix Colors][radix] are very well deisgned. with clear instructions for
+ how to apply them.
- Designed for **automatic light/dark mode**.
-- Variants.
- - It should be straightforward to use helix theme inheritance to swap out the default color palette
-with other radix color combinations without losing the principles of the theme.
-
+- Variants.
+ - It should be straightforward to use helix theme inheritance to swap out the
+ default color palette with other radix color combinations without losing the
+ principles of the theme.
[helix]: https://helix-editor.com/
[zenbones]: https://github.com/mcchrish/zenbones.nvim