Skip to content

Commit

Permalink
docs: refine syntax highlightning #679
Browse files Browse the repository at this point in the history
  • Loading branch information
McShelby committed Nov 25, 2023
1 parent b49668a commit f9f6365
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion exampleSite/content/basics/branding/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
10 changes: 8 additions & 2 deletions exampleSite/content/shortcodes/highlight.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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"
````
Expand Down

0 comments on commit f9f6365

Please sign in to comment.