docs: refine syntax highlightning #679

This commit is contained in:
Sören Weber 2023-11-25 14:41:13 +01:00
parent b49668a203
commit f9f6365b65
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
2 changed files with 9 additions and 3 deletions

View file

@ -89,7 +89,7 @@ Create a new file in `layouts/partials/logo.html` of your site. Then write any H
The size of the logo will adapt automatically.
{{% /notice %}}
## Syntax highlightning
## Syntax Highlightning
If you want to switch the syntax highlighting theme together with your color variant, you need to configure your installation [according to Hugo's documentation](https://gohugo.io/content-management/syntax-highlighting/) and provide a syntax highlighting stylesheet file.

View file

@ -94,6 +94,8 @@ Default values for extension options can be set via params settings in your `con
### Global Configuration File
You can configure the color style used for code blocks in your [color variants stylesheet](basics/branding#syntax-highlightning) file.
#### Recommended Settings
````toml
@ -104,10 +106,14 @@ Default values for extension options can be set via params settings in your `con
lineNumbersInTable = false
# the shipped variants come with their own modified chroma syntax highlightning
# style which is imported in theme-relearn-light.css, theme-relearn-dark.css, etc.;
# if you want to use a predefined style instead:
# stylesheets which are linked in your generated HTML pages; you can use Hugo to generate
# own stylesheets to your liking and use them in your variant;
# if you want to use Hugo's internal styles instead of the shipped stylesheets:
# - remove `noClasses` or set `noClasses = true`
# - set `style` to a predefined style name
# note: with using the internal styles, the `--CODE-theme` setting in your variant
# stylesheet will be ignored and the internal style is used for all variants and
# even print
noClasses = false
# style = "tango"
````