hugo-theme-relearn/cont/syntaxhighlight/index.print.html

136 lines
11 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
<meta name="generator" content="Hugo 0.110.0">
<meta name="generator" content="Relearn 5.11.0+tip">
<meta name="description" content="Documentation for Hugo Relearn Theme">
<meta name="author" content="Sören Weber">
<title>Code highlighting :: Hugo Relearn Theme</title>
<link href="https://McShelby.github.io/hugo-theme-relearn/cont/syntaxhighlight/index.html" rel="alternate" hreflang="x-default">
<link href="https://McShelby.github.io/hugo-theme-relearn/cont/syntaxhighlight/index.html" rel="alternate" hreflang="en">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/cont/syntaxhighlight/index.html" rel="alternate" hreflang="pir">
<link href="https://McShelby.github.io/hugo-theme-relearn/cont/syntaxhighlight/index.html" rel="canonical" type="text/html" title="Code highlighting :: Hugo Relearn Theme">
<link href="../../cont/syntaxhighlight/index.xml" rel="alternate" type="application/rss+xml" title="Code highlighting :: Hugo Relearn Theme">
<link href="../../images/logo.svg?1675662084" rel="icon" type="image/svg+xml">
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
<link href="../../css/fontawesome-all.min.css?1675662085" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1675662085" rel="stylesheet"></noscript>
<link href="../../css/auto-complete.css?1675662085" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1675662085" rel="stylesheet"></noscript>
<link href="../../css/perfect-scrollbar.min.css?1675662085" rel="stylesheet">
<link href="../../css/nucleus.css?1675662085" rel="stylesheet">
<link href="../../css/fonts.css?1675662085" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1675662085" rel="stylesheet"></noscript>
<link href="../../css/theme.css?1675662085" rel="stylesheet">
<link href="../../css/theme-auto.css?1675662085" rel="stylesheet" id="variant-style">
<link href="../../css/ie.css?1675662085" rel="stylesheet">
<link href="../../css/variant.css?1675662085" rel="stylesheet">
<link href="../../css/print.css?1675662085" rel="stylesheet" media="print">
<link href="../../css/format-print.css?1675662085" rel="stylesheet">
<script src="../../js/url.js?1675662085"></script>
<script src="../../js/variant.js?1675662085"></script>
<script>
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
window.index_js_url="../../index.search.js";
var root_url="../../";
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy to clipboard';
window.T_Copied_to_clipboard = 'Copied to clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
window.variants && variants.init( [ 'auto', 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
</script>
<style>
#body img.bg-white {
background-color: white;
}
</style>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../cont/syntaxhighlight/index.html">
<div id="body" class="default-animation">
<div id="sidebar-overlay"></div>
<div id="toc-overlay"></div>
<nav id="topbar" class="highlightable" dir="ltr">
<div>
<div id="breadcrumbs">
<span id="sidebar-toggle-span">
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
</span>
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li>
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../cont/index.html"><span itemprop="name">Content</span></a><meta itemprop="position" content="2"> > </li>
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Code highlighting</span><meta itemprop="position" content="3"></li>
</ol>
</div>
</div>
</nav>
<main id="body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<div id="head-tags">
</div>
<article class="default">
<h1 id="code-highlighting">Code highlighting</h1>
<p>The Relearn theme uses <a href="https://gohugo.io/content-management/syntax-highlighting/" target="_blank">Hugo&rsquo;s built-in syntax highlighting</a> for code.</p>
<h2 id="markdown-syntax">Markdown syntax</h2>
<p>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.</p>
<!-- markdownlint-disable MD046 -->
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```json
</span></span><span class="line"><span class="cl">[
</span></span><span class="line"><span class="cl"> {
</span></span><span class="line"><span class="cl"> &#34;title&#34;: &#34;apples&#34;,
</span></span><span class="line"><span class="cl"> &#34;count&#34;: [12000, 20000],
</span></span><span class="line"><span class="cl"> &#34;description&#34;: {&#34;text&#34;: &#34;...&#34;, &#34;sensitive&#34;: false}
</span></span><span class="line"><span class="cl"> },
</span></span><span class="line"><span class="cl"> {
</span></span><span class="line"><span class="cl"> &#34;title&#34;: &#34;oranges&#34;,
</span></span><span class="line"><span class="cl"> &#34;count&#34;: [17500, null],
</span></span><span class="line"><span class="cl"> &#34;description&#34;: {&#34;text&#34;: &#34;...&#34;, &#34;sensitive&#34;: false}
</span></span><span class="line"><span class="cl"> }
</span></span><span class="line"><span class="cl">]
</span></span><span class="line"><span class="cl">```
</span></span></code></pre></div><!-- markdownlint-disable MD046 -->
<p>Renders to:</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">[</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;title&#34;</span><span class="p">:</span> <span class="s2">&#34;apples&#34;</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;count&#34;</span><span class="p">:</span> <span class="p">[</span><span class="mi">12000</span><span class="p">,</span> <span class="mi">20000</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;description&#34;</span><span class="p">:</span> <span class="p">{</span><span class="nt">&#34;text&#34;</span><span class="p">:</span> <span class="s2">&#34;...&#34;</span><span class="p">,</span> <span class="nt">&#34;sensitive&#34;</span><span class="p">:</span> <span class="kc">false</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;title&#34;</span><span class="p">:</span> <span class="s2">&#34;oranges&#34;</span><span class="p">,</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;count&#34;</span><span class="p">:</span> <span class="p">[</span><span class="mi">17500</span><span class="p">,</span> <span class="kc">null</span><span class="p">],</span>
</span></span><span class="line"><span class="cl"> <span class="nt">&#34;description&#34;</span><span class="p">:</span> <span class="p">{</span><span class="nt">&#34;text&#34;</span><span class="p">:</span> <span class="s2">&#34;...&#34;</span><span class="p">,</span> <span class="nt">&#34;sensitive&#34;</span><span class="p">:</span> <span class="kc">false</span><span class="p">}</span>
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
</span></span><span class="line"><span class="cl"><span class="p">]</span>
</span></span></code></pre></div><h2 id="supported-languages">Supported languages</h2>
<p>Hugo comes with a <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" target="_blank">remarkable list</a> of supported languages.</p>
<h2 id="recommended-configuration">Recommended configuration</h2>
<p>You can choose a color theme from the <a href="https://xyproto.github.io/splash/docs/all.html" target="_blank">list of supported themes</a> and add it in your <code>config.toml</code></p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">markup</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">highlight</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="c"># if `guessSyntax = true`, there will be no unstyled code even if no language</span>
</span></span><span class="line"><span class="cl"> <span class="c"># was given BUT Mermaid and Math codefences will not work anymore! So this is a</span>
</span></span><span class="line"><span class="cl"> <span class="c"># mandatory setting for your site if you want to use Mermaid or Math codefences</span>
</span></span><span class="line"><span class="cl"> <span class="nx">guessSyntax</span> <span class="p">=</span> <span class="kc">false</span>
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> <span class="c"># choose a color theme or create your own</span>
</span></span><span class="line"><span class="cl"> <span class="nx">style</span> <span class="p">=</span> <span class="s2">&#34;base16-snazzy&#34;</span>
</span></span></code></pre></div>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<script src="../../js/clipboard.min.js?1675662085" defer></script>
<script src="../../js/perfect-scrollbar.min.js?1675662085" defer></script>
<script src="../../js/theme.js?1675662085" defer></script>
</body>
</html>