diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/EXPANDED.md | 6 | ||||
| -rw-r--r-- | documentation/FAQ.md | 28 | ||||
| -rw-r--r-- | documentation/REDUCED.md | 6 | ||||
| -rw-r--r-- | documentation/SHOWCASE.md | 4 | ||||
| -rw-r--r-- | documentation/USAGE.md | 4 |
5 files changed, 25 insertions, 23 deletions
diff --git a/documentation/EXPANDED.md b/documentation/EXPANDED.md index 27dd1c9..4ff32a5 100644 --- a/documentation/EXPANDED.md +++ b/documentation/EXPANDED.md @@ -1,6 +1,6 @@ # Expanded Palette -The default color palette is [`color_expanded.css`](../definitions/style/color_expanded.css) and consists of ten colors, eight of which have nine stops; gray, red, pink, purple, blue, green, yellow, orange. Yin (black) has ten stops while yang (white) only has one stop. +The default color palette is [`uchu.css`](../dist/uchu.css) and consists of ten colors, eight of which have nine stops; gray, red, pink, purple, blue, green, yellow, orange. Yin (black) has ten stops while yang (white) only has one stop. If you want more granularity (read: opacity), you can call the raw version of the color (append `-raw` to the variable name) which will return the OKLCH values so you can do something like this: `oklch(var(--uchu-gray-1-raw) / 40%)`. @@ -154,8 +154,8 @@ If you want more granularity (read: opacity), you can call the raw version of th ## Sass -If you know what Sass is, you'll know how to use [`color_expanded.scss`](../definitions/style/color_expanded.scss). I didn't provide raw versions of them because Sass comes with so many color tools (and, I've been using regular CSS variables in my Sass _anyways_). +If you know what Sass is, you’ll know how to use [`_palette.scss`](../dist/_palette.scss). I didn’t provide raw versions of them because Sass comes with so many color tools (and, I’ve been using regular CSS variables in my Sass _anyways_). ## JS -If you are a fan of CSS-in-JS or need to programmatically grab color values, there's [`color.json`](../definitions/script/color_expanded.json) and [`color.ts`](../definitions/script/color_expanded.ts) includes available. +If you are a fan of CSS-in-JS or need to programmatically grab color values, there’s [`dist/index.js`](../dist/index.js). diff --git a/documentation/FAQ.md b/documentation/FAQ.md index 8650c82..c459992 100644 --- a/documentation/FAQ.md +++ b/documentation/FAQ.md @@ -10,13 +10,13 @@ These questions are sourced from the sentiment and actual statements from people High-level: looked at the Wikipedia page for Crayola colors, selected my favorites, put a filter over them in Affinity Designer, made more edits (have to research my notes to figure out details), and eventually landed at these color stops. -It took a long time to settle on yellow/orange because I've never been able to get a good yellow I was happy with, specifically. +It took a long time to settle on yellow/orange because I’ve never been able to get a good yellow I was happy with, specifically. ## Normal colors -> Where's the HEX codes? +> Where’s the HEX codes? The point of this palette is to move away from HEX codes. If you need/want them in your own projects, feel free to fork. @@ -24,9 +24,9 @@ The point of this palette is to move away from HEX codes. If you need/want them ## Dark Mode -> This site doesn't respect my dark mode preference so I left! +> This site doesn’t respect my dark mode preference so I left! -It's not about "respect," I never implemented a dark mode. +It’s not about "respect," I never implemented a dark mode. > A well thought out palette would have all the things @@ -40,19 +40,19 @@ It's not about "respect," I never implemented a dark mode. "uchū" means "universe" in Japanese. I use this theme for all of my projects so...universal. -I can't speak to anything else but personally, I love Japan style/aesthetic/whatever so I'm gonna use a word if it fits. +I can’t speak to anything else but personally, I love Japan style/aesthetic/whatever so I’m gonna use a word if it fits. -> As a non-Japanese person, **I** think that **YOU** shouldn't just pick Japanese words for your project +> As a non-Japanese person, **I** think that **YOU** shouldn’t just pick Japanese words for your project ...okay -> ACKHTUALLY it doesn't mean "universe," it's closer to "space" +> ACKHTUALLY it doesn’t mean "universe," it’s closer to "space" My apologies for not being fluent in the Japanese language. -I didn't look deeper than [WordHippo](https://www.wordhippo.com/what-is/the/japanese-word-for-244fb75b19415c9ee4f143b34b4b241236fb63f5.html) for translation. +I didn’t look deeper than [WordHippo](https://www.wordhippo.com/what-is/the/japanese-word-for-244fb75b19415c9ee4f143b34b4b241236fb63f5.html) for translation. -> Typical American, taking things that don't belong to you. Get bent. +> Typical American, taking things that don’t belong to you. Get bent. (I never responded to this and this person deleted their comments twice to get even nastier) @@ -64,11 +64,11 @@ I didn't look deeper than [WordHippo](https://www.wordhippo.com/what-is/the/japa Beats me, I just wanted to share something cool I made. -> These colors aren't even good +> These colors aren’t even good ...okay? -> If you present something to Hacker News, it better be professional and this is subpar. I don't even know what uchū means. +> If you present something to Hacker News, it better be professional and this is subpar. I don’t even know what uchū means. My bad? @@ -78,9 +78,9 @@ My bad? > This title is clickbait! It annoys me!! -I don't understand... +I don’t understand... -> You don't know how words work!! +> You don’t know how words work!! You got it man. @@ -90,4 +90,4 @@ You got it man. > EXPLAIN TO ME HOW THIS THEME IS FOR SELF-PROFESSED INTERNET LOVERS -It's not that deep bro +It’s not that deep bro diff --git a/documentation/REDUCED.md b/documentation/REDUCED.md index b158161..467dedd 100644 --- a/documentation/REDUCED.md +++ b/documentation/REDUCED.md @@ -1,6 +1,6 @@ # Reduced Palette -Sometimes, an abundance of color options is a hindrance. Analysis paralysis, amirite? To this end [`color.css`](../definitions/style/color.css) reduces the number of stops in the expanded palette to three, save for yin (it only has two) and yang (it only has one). +Sometimes, an abundance of color options is a hindrance. Analysis paralysis, amirite? To this end [`uchu-reduced.css`](../dist/uchu-reduced.css) reduces the number of stops in the expanded palette to three, save for yin (it only has two) and yang (it only has one). If you want more granularity (read: opacity), you can call the raw version of the color (append `-raw` to the variable name) which will return the OKLCH values so you can do something like this: `oklch(var(--uchu-light-gray-raw) / 40%)`. @@ -98,8 +98,8 @@ If you want more granularity (read: opacity), you can call the raw version of th ## Sass -If you know what Sass is, you'll know how to use [`color.scss`](../definitions/style/color.scss). I didn't provide raw versions of them because Sass comes with so many color tools (and, I've been using regular CSS variables in my Sass _anyways_). +If you know what Sass is, you’ll know how to use [`_palette.scss`](../dist/_palette.scss). I didn’t provide raw versions of them because Sass comes with so many color tools (and, I’ve been using regular CSS variables in my Sass _anyways_). ## JS -If you are a fan of CSS-in-JS or need to programmatically grab color values, there's [`color.json`](../definitions/script/color.json) and [`color.ts`](../definitions/script/color.ts) includes available. +If you are a fan of CSS-in-JS or need to programmatically grab color values, there’s [`dist/index.js`](../dist/index.js). diff --git a/documentation/SHOWCASE.md b/documentation/SHOWCASE.md index 33e8f52..1e7301d 100644 --- a/documentation/SHOWCASE.md +++ b/documentation/SHOWCASE.md @@ -1,6 +1,6 @@ # Showcase -If you use uchū for your projects/websites/whatever, file a PR or let me know via [Mastodon](https://social.coop/@netopwibby)/[Blueksy](https://bsky.app/profile/webb.page)! +If you use uchū for your projects/websites/whatever, let me know via [Mastodon](https://social.coop/@netopwibby)/[Blueksy](https://blacksky.community/profile/webb.page)! @@ -8,4 +8,6 @@ If you use uchū for your projects/websites/whatever, file a PR or let me know v - https://webb.page - https://blog.webb.page +- https://forum.webb.page - https://inc.sh +- https://dap.sh diff --git a/documentation/USAGE.md b/documentation/USAGE.md index c3f97ae..ec2bbc9 100644 --- a/documentation/USAGE.md +++ b/documentation/USAGE.md @@ -9,7 +9,7 @@ I love Deno. URL imports are cool. Anyhoo, you can do the same with uchū: ## Pure -If you're coding a website by hand, you probably want to use the reduced palette. Or not, whatever. +If you’re coding a website by hand, you probably want to use the reduced palette. Or not, whatever. ```html <!DOCTYPE html> @@ -39,7 +39,7 @@ If you're coding a website by hand, you probably want to use the reduced palette ## Svelte/SvelteKit -If you're coding a web app, you probably want to use the expanded palette. Or not, whatever. +If you’re coding a web app, you probably want to use the expanded palette. Or not, whatever. ```svelte <script lang="ts"> |