2023-06-21 23:23:13 +00:00
<!DOCTYPE html>
2023-11-28 21:01:15 +00:00
< html lang = "art-pir" dir = "rtl" >
2023-06-21 23:23:13 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2024-01-16 20:23:26 +00:00
< meta name = "generator" content = "Hugo 0.121.2" >
2023-11-03 22:37:57 +00:00
< meta name = "generator" content = "Relearn 5.23.2+tip" >
2023-06-21 23:35:19 +00:00
< meta name = "description" content = "Render code with a syntax highlighter" >
2023-10-10 21:22:41 +00:00
< meta name = "author" content = "Sören Weber" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:card" content = "summary_large_image" >
< meta name = "twitter:image" content = "https://McShelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta name = "twitter:title" content = "Highlight :: Cap'n Hugo Relearrrn Theme" >
< meta name = "twitter:description" content = "Render code with a syntax highlighter" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "Highlight :: Cap'n Hugo Relearrrn Theme" >
< meta property = "og:description" content = "Render code with a syntax highlighter" >
< meta property = "og:type" content = "article" >
2023-10-11 15:42:11 +00:00
< meta property = "og:url" content = "https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/highlight/index.html" >
2023-10-11 15:32:39 +00:00
< meta property = "og:image" content = "https://McShelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta property = "article:section" content = "Shorrrtcodes :: Cap'n Hugo Relearrrn Theme" >
< meta property = "og:site_name" content = "Cap'n Hugo Relearrrn Theme" >
2023-06-21 23:23:13 +00:00
< title > Highlight :: Cap' n Hugo Relearrrn Theme< / title >
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/highlight/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/highlight/index.html" rel = "alternate" hreflang = "en" >
2023-11-28 21:01:15 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/highlight/index.html" rel = "alternate" hreflang = "art-pir" >
2023-06-21 23:23:13 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/highlight/index.html" rel = "canonical" type = "text/html" title = "Highlight :: Cap'n Hugo Relearrrn Theme" >
< link href = "../../../pir/shortcodes/highlight/index.xml" rel = "alternate" type = "application/rss+xml" title = "Highlight :: Cap'n Hugo Relearrrn Theme" >
2024-01-18 20:07:33 +00:00
< link href = "../../../images/logo.svg?1705608449" rel = "icon" type = "image/svg+xml" >
2023-06-21 23:23:13 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2024-01-18 20:07:33 +00:00
< link href = "../../../css/fontawesome-all.min.css?1705608451" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/fontawesome-all.min.css?1705608451" rel = "stylesheet" > < / noscript >
< link href = "../../../css/nucleus.css?1705608451" rel = "stylesheet" >
< link href = "../../../css/auto-complete.css?1705608451" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/auto-complete.css?1705608451" rel = "stylesheet" > < / noscript >
< link href = "../../../css/perfect-scrollbar.min.css?1705608451" rel = "stylesheet" >
< link href = "../../../css/fonts.css?1705608451" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/fonts.css?1705608451" rel = "stylesheet" > < / noscript >
< link href = "../../../css/theme.css?1705608451" rel = "stylesheet" >
< link href = "../../../css/theme-relearn-auto.css?1705608451" rel = "stylesheet" id = "R-variant-style" >
< link href = "../../../css/chroma-relearn-auto.css?1705608451" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "../../../css/variant.css?1705608451" rel = "stylesheet" >
< link href = "../../../css/print.css?1705608451" rel = "stylesheet" media = "print" >
< link href = "../../../css/format-print.css?1705608451" rel = "stylesheet" >
< link href = "../../../css/ie.css?1705608451" rel = "stylesheet" >
< script src = "../../../js/url.js?1705608451" > < / script >
< script src = "../../../js/variant.js?1705608451" > < / script >
2023-06-21 23:23:13 +00:00
< 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="../../../pir/index.search.js";
var root_url="../../../";
var baseUri=root_url.replace(/\/$/, '');
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
window.relearn.baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
// variant stuff
2023-12-03 14:23:32 +00:00
window.relearn.themeVariantModifier='';
2023-11-23 00:05:57 +00:00
window.variants & & variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
2023-11-16 22:53:34 +00:00
// translations
window.T_Copy_to_clipboard = `Copy t' clipboard`;
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
window.T_Reset_view = `Rrreset view`;
window.T_View_reset = `View rrreset!`;
window.T_No_results_found = `No rrresults found fer "{0}"`;
window.T_N_results_found = `{1} rrresults found fer "{0}"`;
2023-06-21 23:23:13 +00:00
< / script >
< style >
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
2023-06-21 23:23:13 +00:00
background-color: white;
}
< / style >
< / head >
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../../pir/shortcodes/highlight/index.html" >
2023-09-23 08:19:35 +00:00
< div id = "R-body" class = "default-animation" >
< div id = "R-body-overlay" > < / div >
< nav id = "R-topbar" >
2023-09-18 18:49:44 +00:00
< div class = "topbar-wrapper" >
2023-09-13 21:30:04 +00:00
< div class = "topbar-sidebar-divider" > < / div >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-start" data-area = "start" >
2023-12-05 07:41:41 +00:00
< div class = "topbar-button topbar-button-sidebar" data-content-empty = "disable" data-width-s = "show" data-width-m = "hide" data-width-l = "hide" > < button class = "topbar-control" onclick = "toggleNav()" type = "button" title = "Menu (CTRL+ALT+n)" > < i class = "fa-fw fas fa-bars" > < / i > < / button >
2023-09-12 21:10:21 +00:00
< / div >
2023-09-13 21:30:04 +00:00
< / div >
2023-09-20 22:28:27 +00:00
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
2023-09-26 20:26:46 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< a itemprop = "item" href = "../../../pir/shortcodes/index.html" > < span itemprop = "name" > Shorrrtcodes< / span > < / a > < meta itemprop = "position" content = "1" > > < / li > < li
2023-09-23 22:28:49 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > Highlight< / span > < meta itemprop = "position" content = "2" > < / li >
2023-09-13 21:30:04 +00:00
< / ol >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-end" data-area = "end" >
2023-09-12 21:19:47 +00:00
< / div >
2023-06-21 23:23:13 +00:00
< / div >
< / nav >
2023-09-23 08:19:35 +00:00
< div id = "R-main-overlay" > < / div >
< main id = "R-body-inner" class = "highlightable default" tabindex = "-1" >
2023-06-21 23:23:13 +00:00
< div class = "flex-block-wrapper" >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "highlight" > Highlight< / h1 >
< div class = "box notices cstyle warning" >
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Arrr! Pirrrates< / div >
< div class = "box-content" >
2023-07-27 15:06:14 +00:00
< p > Fello' pirrrates, grog made us dizzy! Be awarrre < b > some stuff may look weird< / b > in this trrranslat'n. Like < b > Merrrmaids< / b > , do'n < b > math or chemistrrry< / b > and stuff.< / p >
2023-06-21 23:23:13 +00:00
< / div >
< / div >
< p > Th' < code > highlight< / code > shortcode renders yer code wit' a rules highlighter.< / p >
2023-08-12 22:59:45 +00:00
2024-01-18 20:07:33 +00:00
< div class = "tab-panel" data-tab-group = "bd2a6836db475645b2528689254892a9" >
2023-08-12 22:59:45 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="python"
2023-11-18 23:55:52 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-01-18 20:07:33 +00:00
onclick="switchTab('bd2a6836db475645b2528689254892a9','python')"
2023-08-12 22:59:45 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > python< / span >
2023-08-12 22:59:45 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="python"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-py" data-lang = "py" > < span class = "line" > < span class = "ln" > 1< / span > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " Hello World!" < / span > < span class = "p" > )< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< / div >
< / div >
2023-06-21 23:23:13 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-10-28 20:28:18 +00:00
< p > This shortcode be fully compat'ble wit' Hugo’ s < a href = "https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode" target = "_blank" > < code > highlight< / code > shortcode< / a > but < strong > offers some extensions< / strong > .< / p >
2023-08-12 22:59:45 +00:00
< p > It be called interchangeably 'n th' same way as Hugo’ s own shortcode provid'n positional parameter or by simply us'n codefences.< / p >
2023-10-28 20:28:18 +00:00
< p > Ye be free t' also call this shortcode from yer own partials. In this case it resembles Hugo’ s < a href = "https://gohugo.io/functions/highlight/" target = "_blank" > < code > highlight< / code > funct'n< / a > rules if ye call this shortcode as a partial us'n compatiblity rules.< / p >
2023-06-21 23:23:13 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports codefences (eg. GitHub) an' so yer markdown becomes more port'ble.< / p >
2023-07-27 15:06:14 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2023-06-21 23:23:13 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="codefence"
2023-11-18 23:55:52 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2023-07-27 15:06:14 +00:00
onclick="switchTab('shortcode-parameter','codefence')"
2023-06-21 23:23:13 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > codefence< / span >
2023-06-21 23:23:13 +00:00
< / button >
< button
data-tab-item="shortcode"
class="tab-nav-button tab-panel-style cstyle initial"
2023-07-27 15:06:14 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-06-21 23:23:13 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > shortcode< / span >
2023-06-21 23:23:13 +00:00
< / button >
< button
2023-09-05 11:10:04 +00:00
data-tab-item="shortcode-positional"
2023-06-21 23:23:13 +00:00
class="tab-nav-button tab-panel-style cstyle initial"
2023-09-05 11:10:04 +00:00
onclick="switchTab('shortcode-parameter','shortcode-positional')"
2023-06-21 23:23:13 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > shortcode (positional)< / span >
2023-06-21 23:23:13 +00:00
< / button >
< button
data-tab-item="partial"
class="tab-nav-button tab-panel-style cstyle initial"
2023-07-27 15:06:14 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-06-21 23:23:13 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > partial< / span >
2023-06-21 23:23:13 +00:00
< / button >
< button
2023-09-05 11:10:04 +00:00
data-tab-item="partial-compat"
2023-06-21 23:23:13 +00:00
class="tab-nav-button tab-panel-style cstyle initial"
2023-09-05 11:10:04 +00:00
onclick="switchTab('shortcode-parameter','partial-compat')"
2023-06-21 23:23:13 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > partial (compat)< / span >
2023-06-21 23:23:13 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="codefence"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2023-08-12 22:59:45 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ```py { lineNos=" true" wrap=" true" title=" python" }
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > print(" Hello World!" )
< / span > < / span > < span class = "line" > < span class = "cl" > ```< / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< div
data-tab-item="shortcode"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2023-08-12 22:59:45 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > highlight< / span > < span class = "nx" > lineNos< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "kd" > type< / span > < span class = "p" > =< / span > < span class = "s" > " py" < / span > < span class = "nx" > wrap< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " python" < / span > < span class = "p" > > }}< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s" > " Hello World!" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > highlight< / span > < span class = "p" > > }}< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< div
2023-09-05 11:10:04 +00:00
data-tab-item="shortcode-positional"
2023-06-21 23:23:13 +00:00
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2023-08-12 22:59:45 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > highlight< / span > < span class = "nx" > py< / span > < span class = "s" > " lineNos=true,wrap=true,title=python" < / span > < span class = "p" > > }}< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s" > " Hello World!" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > highlight< / span > < span class = "p" > > }}< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< div
data-tab-item="partial"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/highlight.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
2023-07-27 15:06:14 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " page" < / span > < span class = "p" > .< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " print(\" Hello World!\" )" < / span >
2023-06-22 15:37:43 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " lineNos" < / span > < span class = "s" > " true" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " type" < / span > < span class = "s" > " py" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " wrap" < / span > < span class = "s" > " true" < / span >
2023-08-12 22:59:45 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " title" < / span > < span class = "s" > " python" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< div
2023-09-05 11:10:04 +00:00
data-tab-item="partial-compat"
2023-06-21 23:23:13 +00:00
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/highlight.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
2023-07-27 15:06:14 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " page" < / span > < span class = "p" > .< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " print(\" Hello World!\" )" < / span >
2023-08-12 22:59:45 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " options" < / span > < span class = "s" > " lineNos=true,wrap=true,title=python" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " type" < / span > < span class = "s" > " py" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
2023-07-27 15:06:14 +00:00
< th > Name< / th >
2023-10-18 21:23:49 +00:00
< th > Posit'n< / th >
2023-07-27 15:06:14 +00:00
< th > Default< / th >
< th > Notes< / th >
2023-06-21 23:23:13 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2023-07-27 15:06:14 +00:00
< td > < strong > type< / strong > < / td >
2023-10-18 21:23:49 +00:00
< td > 1< / td >
2023-07-27 15:06:14 +00:00
< td > < em > < empty> < / em > < / td >
2023-10-28 20:28:18 +00:00
< td > Th' language o' th' code t' highlight. Choose from one o' th' < a href = "https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" target = "_blank" > supported languages< / a > . Case-insensitive.< / td >
2023-06-21 23:23:13 +00:00
< / tr >
< tr >
2023-08-12 22:59:45 +00:00
< td > < strong > title< / strong > < / td >
2023-10-18 21:23:49 +00:00
< td > < / td >
2023-08-12 22:59:45 +00:00
< td > < em > < empty> < / em > < / td >
2023-10-28 20:28:18 +00:00
< td > < strong > Extension< / strong > . Arbitrary title fer code. This displays th' code like a < a href = "../../../shortcodes/tab/index.html" > single tab< / a > if < code > hl_inline=false< / code > (which be Hugos default).< / td >
2023-08-12 22:59:45 +00:00
< / tr >
< tr >
2023-07-27 15:06:14 +00:00
< td > < strong > wrap< / strong > < / td >
2023-10-18 21:23:49 +00:00
< td > < / td >
2023-07-27 15:06:14 +00:00
< td > see notes< / td >
2023-11-29 23:15:02 +00:00
< td > < strong > Extension< / strong > . When < code > true< / code > th' rrrambl'n may wrap on long lines otherwise it will be scroll'ble.< br > < br > Th' default value can be set 'n yer < code > hugo.toml< / code > an' overwritten via frontmatter. < a href = "#configuration" > See below< / a > .< / td >
2023-06-21 23:23:13 +00:00
< / tr >
< tr >
2023-07-27 15:06:14 +00:00
< td > < strong > opt'ns< / strong > < / td >
2023-10-18 21:23:49 +00:00
< td > 2< / td >
2023-07-27 15:06:14 +00:00
< td > < em > < empty> < / em > < / td >
2023-10-28 20:28:18 +00:00
< td > An optional, comma-separated list o' zero or more < a href = "https://gohugo.io/functions/highlight/#options" target = "_blank" > Cap'n Hugo supported opt'ns< / a > as well as extension parameter from this t'ble.< / td >
2023-06-21 23:23:13 +00:00
< / tr >
< tr >
2023-07-27 15:06:14 +00:00
< td > < em > < strong > < option> < / strong > < / em > < / td >
2023-10-18 21:23:49 +00:00
< td > < / td >
2023-07-27 15:06:14 +00:00
< td > < em > < empty> < / em > < / td >
2023-10-28 20:28:18 +00:00
< td > Any o' < a href = "https://gohugo.io/functions/highlight/#options" target = "_blank" > Hugo’ s supported opt'ns< / a > .< / td >
2023-06-21 23:23:13 +00:00
< / tr >
< tr >
2023-07-27 15:06:14 +00:00
< td > < em > < strong > < content> < / strong > < / em > < / td >
2023-10-18 21:23:49 +00:00
< td > < / td >
2023-07-27 15:06:14 +00:00
< td > < em > < empty> < / em > < / td >
< td > Yer code t' highlight.< / td >
2023-06-21 23:23:13 +00:00
< / tr >
< / tbody >
< / table >
< h2 id = "configuration" > Configurat'n< / h2 >
2023-11-29 23:15:02 +00:00
< p > Default values fer < a href = "https://gohugo.io/functions/highlight/#options" target = "_blank" > Hugo’ s supported opt'ns< / a > can be set via < a href = "https://gohugo.io/getting-started/configuration-markup/#highlight" target = "_blank" > goldmark sett'ns< / a > 'n yer < code > hugo.toml< / code > < / p >
< p > Default values fer extension opt'ns can be set via params sett'ns 'n yer < code > hugo.toml< / code > or be overwritten by frontmatter fer each individual plank.< / p >
2023-06-21 23:23:13 +00:00
< h3 id = "global-configuration-file" > Global Configurat'n File< / h3 >
2023-11-25 13:41:42 +00:00
< p > Ye can configure th' color style used fer code blocks 'n yer < a href = "../../../basics/branding/index.html#syntax-highlightning" > color variants stylesheet< / a > file.< / p >
2023-06-21 23:23:13 +00:00
< h4 id = "recommended-settings" > Recommended Sett'ns< / h4 >
< div class = "wrap-code 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" > marrrkup< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > marrrkup< / 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" > # line numbers 'n a t'ble layout will shift if code be wrapp'n, so better< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # use inline; besides that visually both layouts have th' same look an' behavior< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lineNumbersInT'ble< / 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" > # th' shipped variants come wit' their own modified chroma rules highlightn'n< / span >
2023-11-25 13:41:42 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # stylesheets which be linked 'n yer generated HTML planks; ye can use Cap'n Hugo t' generate< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # own stylesheets t' yer lik'n an' use them 'n yer variant;< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # if ye want t' use Hugo' s internal styles instead o' th' shipped stylesheets:< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # - remove `noClasses` or set `noClasses = true`< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # - set `style` t' a predefined style name< / span >
2023-11-25 13:41:42 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # note: wit' us'n th' internal styles, th' `--CODE-theme` sett'n 'n yer variant< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # stylesheet will be ignored an' th' internal style be used fer all variants an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # even print< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > noClasses< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # style = " tango" < / span > < / span > < / span > < / code > < / pre > < / div > < h4 id = "optional-settings" > Optional Sett'ns< / h4 >
< div class = "wrap-code 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" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > highlightWrap< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div > < h3 id = "pages-frontmatter" > Page’ s Frontmatter< / h3 >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > highlightWrap< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div > < h2 id = "examples" > Examples< / h2 >
2023-08-12 22:59:45 +00:00
< h3 id = "line-numbers-with-starting-offset" > Line Numbers wit' Start'n Offset< / h3 >
2023-11-29 23:15:02 +00:00
< p > As mentioned above, line numbers 'n a < code > t'ble< / code > layout will shift if code be wrapp'n, so better use < code > inline< / code > . T' make th'ns easier fer ye, set < code > lineNumbersInT'ble = false< / code > 'n yer < code > hugo.toml< / code > an' add < code > lineNos = true< / code > when call'n th' shortcode instead o' th' specific values < code > t'ble< / code > or < code > inline< / code > .< / p >
2023-08-12 22:59:45 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > highlight< / span > < span class = "nx" > lineNos< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "nx" > lineNoStart< / span > < span class = "p" > =< / span > < span class = "s" > " 666" < / span > < span class = "kd" > type< / span > < span class = "p" > =< / span > < span class = "s" > " py" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > #< / span > < span class = "nx" > th'< / span > < span class = "nx" > hardest< / span > < span class = "nx" > part< / span > < span class = "nx" > be< / span > < span class = "nx" > t'< / span > < span class = "nx" > start< / span > < span class = "nx" > writ'n< / span > < span class = "nx" > code< / span > < span class = "p" > ;< / span > < span class = "nx" > here< / span > < span class = "err" > ' < / span > < span class = "nx" > s< / span > < span class = "nx" > a< / span > < span class = "nx" > kickstart< / span > < span class = "p" > ;< / span > < span class = "nx" > just< / span > < span class = "nx" > copy< / span > < span class = "nx" > an'< / span > < span class = "nx" > paste< / span > < span class = "nx" > this< / span > < span class = "p" > ;< / span > < span class = "nx" > it< / span > < span class = "err" > ' < / span > < span class = "nx" > s< / span > < span class = "nx" > free< / span > < span class = "p" > ;< / span > < span class = "nx" > th'< / span > < span class = "nx" > next< / span > < span class = "nx" > lines< / span > < span class = "nx" > will< / span > < span class = "nx" > cost< / span > < span class = "nx" > ye< / span > < span class = "nx" > serious< / span > < span class = "nx" > credits< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s" > " Hello" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s" > " " < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s" > " World" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s" > " !" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > highlight< / span > < span class = "p" > > }}< / span > < / span > < / span > < / code > < / pre > < / div > < div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-py" data-lang = "py" > < span class = "line" > < span class = "ln" > 666< / span > < span class = "cl" > < span class = "c1" > # th' hardest part be t' start writ'n code; here' s a kickstart; just copy an' paste this; it' s free; th' next lines will cost ye serious credits< / span >
< / span > < / span > < span class = "line" > < span class = "ln" > 667< / span > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " Hello" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "ln" > 668< / span > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " " < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "ln" > 669< / span > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " World" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "ln" > 670< / span > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " !" < / span > < span class = "p" > )< / span > < / span > < / span > < / code > < / pre > < / div >
< h3 id = "codefence-with-title" > Codefence wit' Title< / h3 >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ```py { title=" python" }
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gh" > # a bit shorter
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gh" > < / span > print(" Hello World!" )
< / span > < / span > < span class = "line" > < span class = "cl" > ```< / span > < / span > < / code > < / pre > < / div >
2024-01-18 20:07:33 +00:00
< div class = "tab-panel" data-tab-group = "06f402650d4cfeae369ae551bac10d7b" >
2023-08-12 22:59:45 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="python"
2023-11-18 23:55:52 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-01-18 20:07:33 +00:00
onclick="switchTab('06f402650d4cfeae369ae551bac10d7b','python')"
2023-08-12 22:59:45 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > python< / span >
2023-08-12 22:59:45 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="python"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-py" data-lang = "py" > < span class = "line" > < span class = "cl" > < span class = "c1" > # a bit shorter< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " Hello World!" < / span > < span class = "p" > )< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< / div >
< / div > < h3 id = "with-wrap" > Wit' Wrap< / h3 >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > highlight< / span > < span class = "kd" > type< / span > < span class = "p" > =< / span > < span class = "s" > " py" < / span > < span class = "nx" > wrap< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "nx" > hl_lines< / span > < span class = "p" > =< / span > < span class = "s" > " 2" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > #< / span > < span class = "nx" > Quicksort< / span > < span class = "nx" > Python< / span > < span class = "nx" > One< / span > < span class = "o" > -< / span > < span class = "nx" > liner< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lambda< / span > < span class = "nx" > L< / span > < span class = "p" > :< / span > < span class = "p" > []< / span > < span class = "k" > if< / span > < span class = "nx" > L< / span > < span class = "o" > ==< / span > < span class = "p" > []< / span > < span class = "k" > else< / span > < span class = "nf" > qsort< / span > < span class = "p" > ([< / span > < span class = "nx" > x< / span > < span class = "k" > fer< / span > < span class = "nx" > x< / span > < span class = "nx" > 'n< / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > :]< / span > < span class = "k" > if< / span > < span class = "nx" > x< / span > < span class = "p" > < < / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]])< / span > < span class = "o" > +< / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span > < span class = "o" > +< / span > < span class = "nf" > qsort< / span > < span class = "p" > ([< / span > < span class = "nx" > x< / span > < span class = "k" > fer< / span > < span class = "nx" > x< / span > < span class = "nx" > 'n< / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > :]< / span > < span class = "k" > if< / span > < span class = "nx" > x< / span > < span class = "o" > > =< / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]])< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > #< / span > < span class = "nx" > Some< / span > < span class = "nx" > more< / span > < span class = "nx" > stuff< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > highlight< / span > < span class = "p" > > }}< / span > < / span > < / span > < / code > < / pre > < / div > < div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-py" data-lang = "py" > < span class = "line" > < span class = "cl" > < span class = "c1" > # Quicksort Python One-liner< / span >
< / span > < / span > < span class = "line hl" > < span class = "cl" > < span class = "k" > lambda< / span > < span class = "n" > L< / span > < span class = "p" > :< / span > < span class = "p" > []< / span > < span class = "k" > if< / span > < span class = "n" > L< / span > < span class = "o" > ==< / span > < span class = "p" > []< / span > < span class = "k" > else< / span > < span class = "n" > qsort< / span > < span class = "p" > ([< / span > < span class = "n" > x< / span > < span class = "k" > fer< / span > < span class = "n" > x< / span > < span class = "ow" > 'n< / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > :]< / span > < span class = "k" > if< / span > < span class = "n" > x< / span > < span class = "o" > < < / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]])< / span > < span class = "o" > +< / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span > < span class = "o" > +< / span > < span class = "n" > qsort< / span > < span class = "p" > ([< / span > < span class = "n" > x< / span > < span class = "k" > fer< / span > < span class = "n" > x< / span > < span class = "ow" > 'n< / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > :]< / span > < span class = "k" > if< / span > < span class = "n" > x< / span > < span class = "o" > > =< / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]])< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c1" > # Some more stuff< / span > < / span > < / span > < / code > < / pre > < / div >
< h3 id = "without-wrap" > Without Wrap< / h3 >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > highlight< / span > < span class = "kd" > type< / span > < span class = "p" > =< / span > < span class = "s" > " py" < / span > < span class = "nx" > wrap< / span > < span class = "p" > =< / span > < span class = "s" > " false" < / span > < span class = "nx" > hl_lines< / span > < span class = "p" > =< / span > < span class = "s" > " 2" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > #< / span > < span class = "nx" > Quicksort< / span > < span class = "nx" > Python< / span > < span class = "nx" > One< / span > < span class = "o" > -< / span > < span class = "nx" > liner< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lambda< / span > < span class = "nx" > L< / span > < span class = "p" > :< / span > < span class = "p" > []< / span > < span class = "k" > if< / span > < span class = "nx" > L< / span > < span class = "o" > ==< / span > < span class = "p" > []< / span > < span class = "k" > else< / span > < span class = "nf" > qsort< / span > < span class = "p" > ([< / span > < span class = "nx" > x< / span > < span class = "k" > fer< / span > < span class = "nx" > x< / span > < span class = "nx" > 'n< / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > :]< / span > < span class = "k" > if< / span > < span class = "nx" > x< / span > < span class = "p" > < < / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]])< / span > < span class = "o" > +< / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span > < span class = "o" > +< / span > < span class = "nf" > qsort< / span > < span class = "p" > ([< / span > < span class = "nx" > x< / span > < span class = "k" > fer< / span > < span class = "nx" > x< / span > < span class = "nx" > 'n< / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > :]< / span > < span class = "k" > if< / span > < span class = "nx" > x< / span > < span class = "o" > > =< / span > < span class = "nx" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]])< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > #< / span > < span class = "nx" > Some< / span > < span class = "nx" > more< / span > < span class = "nx" > stuff< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > highlight< / span > < span class = "p" > > }}< / span > < / span > < / span > < / code > < / pre > < / div > < div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-py" data-lang = "py" > < span class = "line" > < span class = "cl" > < span class = "c1" > # Quicksort Python One-liner< / span >
< / span > < / span > < span class = "line hl" > < span class = "cl" > < span class = "k" > lambda< / span > < span class = "n" > L< / span > < span class = "p" > :< / span > < span class = "p" > []< / span > < span class = "k" > if< / span > < span class = "n" > L< / span > < span class = "o" > ==< / span > < span class = "p" > []< / span > < span class = "k" > else< / span > < span class = "n" > qsort< / span > < span class = "p" > ([< / span > < span class = "n" > x< / span > < span class = "k" > fer< / span > < span class = "n" > x< / span > < span class = "ow" > 'n< / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > :]< / span > < span class = "k" > if< / span > < span class = "n" > x< / span > < span class = "o" > < < / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]])< / span > < span class = "o" > +< / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ]< / span > < span class = "o" > +< / span > < span class = "n" > qsort< / span > < span class = "p" > ([< / span > < span class = "n" > x< / span > < span class = "k" > fer< / span > < span class = "n" > x< / span > < span class = "ow" > 'n< / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 1< / span > < span class = "p" > :]< / span > < span class = "k" > if< / span > < span class = "n" > x< / span > < span class = "o" > > =< / span > < span class = "n" > L< / span > < span class = "p" > [< / span > < span class = "mi" > 0< / span > < span class = "p" > ]])< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c1" > # Some more stuff< / span > < / span > < / span > < / code > < / pre > < / div >
< footer class = "footline" >
< / footer >
< / article >
< / div >
< / main >
< / div >
2024-01-18 20:07:33 +00:00
< script src = "../../../js/clipboard.min.js?1705608451" defer > < / script >
< script src = "../../../js/perfect-scrollbar.min.js?1705608451" defer > < / script >
< script src = "../../../js/theme.js?1705608451" defer > < / script >
2023-06-21 23:23:13 +00:00
< / body >
< / html >
