nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 09:43:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
hugo-theme-relearn/exampleSite/content/cont/syntaxhighlight.en.md

62 lines
1.5 KiB
Markdown
Raw Normal View History

theme: convert front matter to TOML #52 remove date field
2021-08-25 11:33:29 +00:00
+++
title = "Code highlighting"
weight = 16
+++
Add additional documentation for code highlighting
2020-06-01 13:59:45 +00:00
docs: showcase multilang feature #87 Arrr, Pirrrate trrranslat'n
2021-09-11 13:46:14 +00:00
The Relearn theme uses [Hugo's built-in syntax highlighting](https://gohugo.io/content-management/syntax-highlighting/) for code.
Add additional documentation for code highlighting
2020-06-01 13:59:45 +00:00
## Markdown syntax
Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided.
<!-- markdownlint-disable MD046 -->
code highligher: switch to standard hugo highlighter #32 Since a while, Hugo has its own mechanism for code highlightning. We remove the old highlightning code provided by the client-side javascript library highlight.js and all its related files. This also solves issues introduced by Hugos own highlightning because in our theme we are currently highlighting the code twice leading to unpredictiable results. This will also fix an issue were light code highlightning themes weren't displayed correctly because our styles are overwriting color information. Another advantage is the huge list of supported languages which by far exceeds our current list. On the downside, this is a breaking change because our current color theme isn't supported by Hugo.
2021-07-25 23:05:46 +00:00
````plaintext
```json
[
{
"title": "apples",
"count": [12000, 20000],
"description": {"text": "...", "sensitive": false}
},
{
"title": "oranges",
"count": [17500, null],
"description": {"text": "...", "sensitive": false}
}
]
Add additional documentation for code highlighting
2020-06-01 13:59:45 +00:00
```
code highligher: switch to standard hugo highlighter #32 Since a while, Hugo has its own mechanism for code highlightning. We remove the old highlightning code provided by the client-side javascript library highlight.js and all its related files. This also solves issues introduced by Hugos own highlightning because in our theme we are currently highlighting the code twice leading to unpredictiable results. This will also fix an issue were light code highlightning themes weren't displayed correctly because our styles are overwriting color information. Another advantage is the huge list of supported languages which by far exceeds our current list. On the downside, this is a breaking change because our current color theme isn't supported by Hugo.
2021-07-25 23:05:46 +00:00
````
Add additional documentation for code highlighting
2020-06-01 13:59:45 +00:00
<!-- markdownlint-disable MD046 -->
Renders to:
```json
[
{
"title": "apples",
"count": [12000, 20000],
"description": {"text": "...", "sensitive": false}
},
{
"title": "oranges",
"count": [17500, null],
"description": {"text": "...", "sensitive": false}
}
]
```
## Supported languages
Fix typos in exampleSite
2021-08-23 22:46:53 +00:00
Hugo comes with a [remarkable list](https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages) of supported languages.
Add additional documentation for code highlighting
2020-06-01 13:59:45 +00:00
docs: block code doesn't always has a background #100
2021-09-23 19:46:32 +00:00
## Recommended configuration
Add additional documentation for code highlighting
2020-06-01 13:59:45 +00:00
code highligher: switch to standard hugo highlighter #32 Since a while, Hugo has its own mechanism for code highlightning. We remove the old highlightning code provided by the client-side javascript library highlight.js and all its related files. This also solves issues introduced by Hugos own highlightning because in our theme we are currently highlighting the code twice leading to unpredictiable results. This will also fix an issue were light code highlightning themes weren't displayed correctly because our styles are overwriting color information. Another advantage is the huge list of supported languages which by far exceeds our current list. On the downside, this is a breaking change because our current color theme isn't supported by Hugo.
2021-07-25 23:05:46 +00:00
You can choose a color theme from the [list of supported themes](https://xyproto.github.io/splash/docs/all.html) and add it in your `config.toml`
Add additional documentation for code highlighting
2020-06-01 13:59:45 +00:00
code highligher: switch to standard hugo highlighter #32 Since a while, Hugo has its own mechanism for code highlightning. We remove the old highlightning code provided by the client-side javascript library highlight.js and all its related files. This also solves issues introduced by Hugos own highlightning because in our theme we are currently highlighting the code twice leading to unpredictiable results. This will also fix an issue were light code highlightning themes weren't displayed correctly because our styles are overwriting color information. Another advantage is the huge list of supported languages which by far exceeds our current list. On the downside, this is a breaking change because our current color theme isn't supported by Hugo.
2021-07-25 23:05:46 +00:00
````toml
[markup]
[markup.highlight]
docs: change chroma theme as it looks weird for certain markers #99
2021-09-23 20:13:37 +00:00
style = "base16-snazzy" # choose a color theme or create your own
clarify caveats for mermaid code fences
2021-10-07 21:01:04 +00:00
guessSyntax = false # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore
code highligher: switch to standard hugo highlighter #32 Since a while, Hugo has its own mechanism for code highlightning. We remove the old highlightning code provided by the client-side javascript library highlight.js and all its related files. This also solves issues introduced by Hugos own highlightning because in our theme we are currently highlighting the code twice leading to unpredictiable results. This will also fix an issue were light code highlightning themes weren't displayed correctly because our styles are overwriting color information. Another advantage is the huge list of supported languages which by far exceeds our current list. On the downside, this is a breaking change because our current color theme isn't supported by Hugo.
2021-07-25 23:05:46 +00:00
````
Reference in a new issue Copy permalink