From c71bc520d76cddfc7f09bd4294fef8c4270bab16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Sun, 13 Oct 2024 14:50:19 +0200 Subject: [PATCH] docs: list available variants #567 do visually impaired people a favor --- README.md | 2 +- .../branding/colors/_index.en.md | 21 ++++++++++++++++++- layouts/partials/version.txt | 2 +- 3 files changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a2875c1ccb..9b6169295e 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ The Relearn theme is an enhanced fork of the popular [Learn theme](https://githu - **Customizable Appearance** - [Flexible brand image configuration](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/logo#change-the-logo) - [Automatic light/dark mode switching based on OS settings](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/colors#adjust-to-os-settings) - - Many pre-defined color variants + - [Many pre-defined color variants](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/colors#shipped-variants) - [User-selectable variants](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/colors#multiple-variants) - [Built-in stylesheet generator](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/generator) - [Customizable syntax highlighting](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/modules/#change-syntax-highlighting) diff --git a/exampleSite/content/configuration/branding/colors/_index.en.md b/exampleSite/content/configuration/branding/colors/_index.en.md index e33ced2f37..f13ca7be2a 100644 --- a/exampleSite/content/configuration/branding/colors/_index.en.md +++ b/exampleSite/content/configuration/branding/colors/_index.en.md @@ -8,10 +8,29 @@ weight = 2 The Relearn theme offers color variants to change your site's appearance. Each color variant contains of a CSS file and optional settings in your `hugo.toml`. -You can use the pre-made variants, [customize them](#modifying-variants), or create your own. The [interactive variant generator](configuration/branding/generator) can help you with this. +You can use the [shipped variants](#shipped-variants), [customize them](#modifying-variants), or create your own. The [interactive variant generator](configuration/branding/generator) can help you with this. Once set up in `hugo.toml`, you can switch variants using the selector at the bottom of the menu. +## Shipped Variants + +The theme ships with the following set of variants + +- Relearn + - Light: the classic Relearn default, coming with signature green, dark sidebar and light content area + - Dark: dark variant of Light, coming with signature green, dark sidebar and dark content area + - Bright: alternative of Light, coming with signature green, green sidebar and light content area +- Zen + - Light: a more relaxed white/grey variant, coming with blue accents, light sidebar and light content area + - Dark: dark variant of Light, coming with blue accents, dark sidebar and dark content area +- Experimental + - Neon: a variant that glows in the dark, gradient sidebar and dark content area +- Retro + - Learn: the default of the old Learn theme, coming with signature light purple, dark sidebar and light content area + - Blue: a blue variant of the old Learn theme, coming tinted in blue, dark sidebar and light content area + - Green: a green variant of the old Learn theme, coming tinted in green, dark sidebar and light content area + - Red: a red variant of the old Learn theme, coming tinted in red, dark sidebar and light content area + ## Changing the Variant {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set the `themeVariant` option to change the variant. diff --git a/layouts/partials/version.txt b/layouts/partials/version.txt index 6917fc38bd..6fbf7c5329 100644 --- a/layouts/partials/version.txt +++ b/layouts/partials/version.txt @@ -1 +1 @@ -6.4.0+0c81706cf559d1a82a1b6910aa8195b004c2dc49 \ No newline at end of file +6.4.0+11bc52f2df72bf90413142902cd9fe98c7374cc6 \ No newline at end of file