nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 07:47:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: list available variants #567

Browse source 
do visually impaired people a favor
This commit is contained in:
Sören Weber 2024-10-13 14:50:19 +02:00
parent 11bc52f2df
commit c71bc520d7
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
3 changed files with 22 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -22,7 +22,7 @@ The Relearn theme is an enhanced fork of the popular [Learn theme](https://githu
- **Customizable Appearance** - **Customizable Appearance**
- [Flexible brand image configuration](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/logo#change-the-logo) - [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) - [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) - [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) - [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) - [Customizable syntax highlighting](https://mcshelby.github.io/hugo-theme-relearn/configuration/branding/modules/#change-syntax-highlighting)

21
exampleSite/content/configuration/branding/colors/_index.en.md
View file

@ -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`. 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. 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 ## Changing the Variant
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set the `themeVariant` option to change the variant. {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} Set the `themeVariant` option to change the variant.

2
layouts/partials/version.txt
View file

@ -1 +1 @@
6.4.0+0c81706cf559d1a82a1b6910aa8195b004c2dc49 6.4.0+11bc52f2df72bf90413142902cd9fe98c7374cc6