From 0036932693ca1f98873e1d9248bb7e58b4a750f4 Mon Sep 17 00:00:00 2001 From: Nadiyar <106643149+Naadiyaar@users.noreply.github.com> Date: Mon, 5 May 2025 00:41:19 +0000 Subject: [PATCH] docs: improve existing lunacolors guide (#331) * docs: extend the lunacolors guide * docs: add lunacolors change to CHANGELOG --------- Co-authored-by: sammyette --- CHANGELOG.md | 2 ++ docs/lunacolors.md | 13 ++++++++----- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 58a0cd6..a2e95ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,8 @@ ## Unreleased ### Added - Forward/Right arrow key will fill in hint text (#327) +### Changed +- Documentation for Lunacolors has been improved, with more information added. - Values returned by bait hooks will be passed to the `throw` caller ## [2.3.4] - 2024-12-28 diff --git a/docs/lunacolors.md b/docs/lunacolors.md index bde809c..f350d9e 100644 --- a/docs/lunacolors.md +++ b/docs/lunacolors.md @@ -18,7 +18,7 @@ In other usage, you may want to use a format string instead of having multiple nested functions for different styles. This is where the format function comes in. You can used named keywords to style a section of text. -The list of arguments are: +The list of arguments are: Colors: - black - red @@ -28,14 +28,17 @@ Colors: - magenta - cyan - white + Styles: +- reset - bold - dim - italic - underline - invert -For the colors, there are background and bright variants. The background -color variants have a suffix of `Bg` and bright has a prefix of `bright`. -Note that appropriate camel casing has to be applied to them. So bright -blue would be `brightBlue` and background cyan would be `cyanBg`. +For the colors, there are background and bright variants. Background color +variants have a `Bg` suffix, while bright variants use the `bright` prefix. +These can also be combined. Note that appropriate camel casing must be applied. +For example, bright blue would be written as `brightBlue`, a cyan background as +`cyanBg`, and combining them would result in `brightBlueBg`.