2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2024-04-30 20:08:46 +00:00
< html lang = "art-x-pir" dir = "rtl" itemscope itemtype = "http://schema.org/Article" >
2022-04-02 13:30:16 +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-10-11 14:17:37 +00:00
< meta name = "generator" content = "Hugo 0.135.0" >
2024-10-15 10:39:20 +00:00
< meta name = "generator" content = "Relearn 7.0.0+007cc20686f04ca1f911975f20f097175dd72a7f" >
2024-10-13 14:26:50 +00:00
< meta name = "description" content = "Learrrn how t & # 39 ; create an & # 39 ; org & # 39 ; nize yer rrrambl & # 39 ; n planks .
Directory StructureYer content' s directory structure">
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" >
2024-02-24 13:03:50 +00:00
< meta name = "twitter:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:title" content = "Rambl'n :: Cap'n Hugo Relearrrn Theme" >
2024-10-13 14:26:50 +00:00
< meta name = "twitter:description" content = "Learrrn how t & # 39 ; create an & # 39 ; org & # 39 ; nize yer rrrambl & # 39 ; n planks .
Directory StructureYer content' s directory structure">
< meta property = "og:url" content = "https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/index.html" >
2024-04-07 13:13:19 +00:00
< meta property = "og:site_name" content = "Cap'n Hugo Relearrrn Theme" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "Rambl'n :: Cap'n Hugo Relearrrn Theme" >
2024-10-13 14:26:50 +00:00
< meta property = "og:description" content = "Learrrn how t & # 39 ; create an & # 39 ; org & # 39 ; nize yer rrrambl & # 39 ; n planks .
Directory StructureYer content' s directory structure">
2024-06-05 21:20:58 +00:00
< meta property = "og:locale" content = "art_x_pir" >
2023-10-11 15:32:39 +00:00
< meta property = "og:type" content = "website" >
2024-02-24 13:03:50 +00:00
< meta property = "og:image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-04-24 19:38:41 +00:00
< meta itemprop = "name" content = "Rambl'n :: Cap'n Hugo Relearrrn Theme" >
2024-10-13 14:26:50 +00:00
< meta itemprop = "description" content = "Learrrn how t & # 39 ; create an & # 39 ; org & # 39 ; nize yer rrrambl & # 39 ; n planks .
Directory StructureYer content' s directory structure">
< meta itemprop = "wordCount" content = "42" >
2024-04-24 19:38:41 +00:00
< meta itemprop = "image" content = "https://mcshelby.github.io/hugo-theme-relearn/images/hero.png" >
2024-10-13 14:26:50 +00:00
< meta itemprop = "keywords" content = "Reference" >
2022-04-02 13:30:16 +00:00
< title > Rambl' n :: Cap' n Hugo Relearrrn Theme< / title >
2024-10-13 14:26:50 +00:00
< link href = "https://mcshelby.github.io/hugo-theme-relearn/authoring/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/authoring/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/index.html" rel = "alternate" hreflang = "art-x-pir" >
< link href = "https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/index.html" rel = "canonical" type = "text/html" title = "Rambl'n :: Cap'n Hugo Relearrrn Theme" >
< link href = "/hugo-theme-relearn/pir/authoring/index.xml" rel = "alternate" type = "application/rss+xml" title = "Rambl'n :: Cap'n Hugo Relearrrn Theme" >
2024-10-15 10:39:20 +00:00
< link href = "/hugo-theme-relearn/images/logo.svg?1728988750" rel = "icon" type = "image/svg+xml" >
< link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1728988750" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fontawesome-all.min.css?1728988750" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/nucleus.css?1728988750" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/auto-complete.css?1728988750" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/auto-complete.css?1728988750" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/perfect-scrollbar.min.css?1728988750" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/fonts.css?1728988750" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "/hugo-theme-relearn/css/fonts.css?1728988750" rel = "stylesheet" > < / noscript >
< link href = "/hugo-theme-relearn/css/theme.css?1728988750" rel = "stylesheet" >
< link href = "/hugo-theme-relearn/css/theme-relearn-auto.css?1728988750" rel = "stylesheet" id = "R-variant-style" >
< link href = "/hugo-theme-relearn/css/chroma-relearn-auto.css?1728988750" rel = "stylesheet" id = "R-variant-chroma-style" >
< link href = "/hugo-theme-relearn/css/print.css?1728988750" rel = "stylesheet" media = "print" >
< link href = "/hugo-theme-relearn/css/format-print.css?1728988750" rel = "stylesheet" >
< script src = "/hugo-theme-relearn/js/variant.js?1728988750" > < / script >
2024-03-16 13:44:28 +00:00
< script >
2023-11-16 22:53:34 +00:00
window.relearn = window.relearn || {};
2024-03-18 20:59:19 +00:00
window.relearn.relBasePath='..\/..';
window.relearn.relBaseUri='..\/..\/..';
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
2024-08-22 16:34:04 +00:00
window.relearn.disableAnchorCopy=false;
window.relearn.disableAnchorScrolling=false;
2023-11-16 22:53:34 +00:00
// variant stuff
2024-04-19 06:38:17 +00:00
window.variants & & variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', '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}"`;
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:05:54 +00:00
< style >
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
2022-12-02 15:05:54 +00:00
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2024-10-13 14:26:50 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "/hugo-theme-relearn/pir/authoring/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 >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-toc" data-content-empty = "hide" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < button class = "topbar-control" onclick = "toggleTopbarFlyout(this)" type = "button" title = "Table o' Contents (CTRL+ALT+t)" > < i class = "fa-fw fas fa-list-alt" > < / i > < / button >
< div class = "topbar-content" >
< div class = "topbar-content-wrapper" >
< / div >
< / div >
< / 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-23 22:28:49 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > Rambl' n< / span > < meta itemprop = "position" content = "1" > < / 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" >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-edit" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/authoring/_index.pir.md" target = "_self" title = "Edit (CTRL+ALT+w)" > < i class = "fa-fw fas fa-pen" > < / i > < / a >
< / div >
< div class = "topbar-button topbar-button-print" data-content-empty = "disable" data-width-s = "area-more" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/pir/authoring/index.print.html" title = "Prrrint whole chapterrr (CTRL+ALT+p)" > < i class = "fa-fw fas fa-print" > < / i > < / a >
< / div >
< div class = "topbar-button topbar-button-prev" data-content-empty = "disable" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/pir/configuration/reference/index.html" title = "Options Reference (🡒)" > < i class = "fa-fw fas fa-chevron-left" > < / i > < / a >
< / div >
< div class = "topbar-button topbar-button-next" data-content-empty = "disable" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < a class = "topbar-control" href = "/hugo-theme-relearn/pir/authoring/structure/index.html" title = "Directory Structure (🡐)" > < i class = "fa-fw fas fa-chevron-right" > < / i > < / a >
2024-04-07 19:58:38 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "topbar-button topbar-button-more" data-content-empty = "hide" data-width-s = "show" data-width-m = "show" data-width-l = "show" > < button class = "topbar-control" onclick = "toggleTopbarFlyout(this)" type = "button" title = "Morrre" > < i class = "fa-fw fas fa-ellipsis-v" > < / i > < / button >
< div class = "topbar-content" >
< div class = "topbar-content-wrapper" >
< div class = "topbar-area topbar-area-more" data-area = "more" >
< / div >
< / div >
< / div >
2024-04-07 19:58:38 +00:00
< / div >
2023-09-12 21:19:47 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< / nav >
2023-09-23 08:19:35 +00:00
< div id = "R-main-overlay" > < / div >
2024-10-13 14:26:50 +00:00
< main id = "R-body-inner" class = "highlightable chapter" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
2024-10-13 14:26:50 +00:00
< article class = "chapter narrow" >
< header class = "headline" >
< / header >
< div class = "article-subheading" > T' chapterrr 3< / div >
2024-04-07 19:58:38 +00:00
2022-11-13 21:34:47 +00:00
< h1 id = "rambln" > Rambl' n< / h1 >
2022-04-02 13:30:16 +00:00
2024-10-13 14:26:50 +00:00
< p > Learrrn how t' create an' org'nize yer rrrambl'n planks.< / p >
< div class = "children children-h2 children-sort-" >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/structure/index.html" > Directory Structure< / a > < / h2 > < p > Yer content' s directory structure< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/index.html" > Front Matter< / a > < / h2 > < p > All th'ns front matter< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/meta/index.html" > Meta Informat'n< / a > < / h2 > < p > What plank meta informat'n be avail'ble< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/markdown/index.html" > Marrrkdown Rules< / a > < / h2 > < p > Reference o' CommonMark an' Marrrkdown extensions< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/imageeffects/index.html" > Image Effects< / a > < / h2 > < p > How t' apply graphical effects t' yer images< / p >
< / div >
2024-04-24 21:05:57 +00:00
2022-04-02 13:30:16 +00:00
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/reference/index.html" > Reference< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsct' ns o' Rambl' n< / h1 >
2024-10-13 14:26:50 +00:00
< article class = "default" >
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2024-10-13 14:26:50 +00:00
< h1 id = "directory-structure" > Directory Structure< / h1 >
2022-04-02 13:30:16 +00:00
2024-10-13 14:26:50 +00:00
< p > In < strong > Cap'n Hugo< / strong > , planks be th' core o' yer ship.< / p >
< p > Th' theme generates th' navigat'n menu out o' th' given directory structure.< / p >
< p > Org'nize yer ship like < a href = "https://gohugo.io/content/structure/" rel = "external" target = "_self" > any other Cap'n Hugo project< / a > . Typically, ye will have a < em > rrrambl'n< / em > directory wit' all yer planks.< / p >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > rrrambl'n
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ├── first-chapter
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── first-page
< / span > < / span > < span class = "line" > < span class = "cl" > | | |── _index.md
< / span > < / span > < span class = "line" > < span class = "cl" > | │ ├── first-sub-page
< / span > < / span > < span class = "line" > < span class = "cl" > | | | |── _index.md
< / span > < / span > < span class = "line" > < span class = "cl" > | | | |── picture1.png
< / span > < / span > < span class = "line" > < span class = "cl" > | | | └── plain.txt
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── second-page
< / span > < / span > < span class = "line" > < span class = "cl" > | | |── index.md
< / span > < / span > < span class = "line" > < span class = "cl" > | | |── picture1.png
< / span > < / span > < span class = "line" > < span class = "cl" > | | └── picture2.png
< / span > < / span > < span class = "line" > < span class = "cl" > │ └── third-page.md
< / span > < / span > < span class = "line" > < span class = "cl" > └── _index.md< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle note" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast
< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > While ye can also go different, < code > _index.md< / code > (with an underscore) be recommended fer each directory, it’ s yer < em > directory’ s home plank< / em > .< / p >
< p > See < a href = "https://gohugo.io/content-management/" rel = "external" target = "_self" > Hugo’ s guide fer rrrambl'n < / a > t' learn more.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2024-04-24 21:05:57 +00:00
2023-11-28 22:52:52 +00:00
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/explanation/index.html" > Explanation< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "front-matter" > Front Matter< / h1 >
< div class = "children children-h2 children-sort-" >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/designs/index.html" > Plank Designs< / a > < / h2 > < p > How t' vary layouts by us'n plank designs< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/navigationmenu/index.html" > Navigat'n Menu< / a > < / h2 > < p > Behavior o' th' navigat'n menu< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/linking/index.html" > Link'n< / a > < / h2 > < p > What opt'ns be avail'ble fer links an' images< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html" > Topbar< / a > < / h2 > < p > Configure th' topbar< / p >
< h2 > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.html" > Front Matter Reference< / a > < / h2 > < p > All front matter fer th' Relearrrn theme< / p >
< / div >
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/reference/index.html" > Reference< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< section >
< h1 class = "a11y-only" > Subsct' ns o' Front Matter< / h1 >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "page-designs" > Page Designs< / h1 >
< p > A plank be displayed by exactly one plank design an' represented by < a href = "https://gohugo.io/content-management/front-matter/#type" rel = "external" target = "_self" > Hugo’ s reserved < code > type< / code > front matter< / a > .< / p >
< p > Th' Relearrrn theme offers th' plank designs < code > home< / code > , < code > chapter< / code > , an' < code > default< / code > but ye can < a href = "/hugo-theme-relearn/pir/configuration/customization/designs/index.html" > define further custom plank designs< / a > .< / p >
< p > Regardless o' shipped or custom plank design, ye be us'n them 'n th' same way.< / p >
< ul >
< li >
< p > If ye have an < a href = "https://gohugo.io/content-management/archetypes/" rel = "external" target = "_self" > archetype file< / a > , ye can just do< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind chapter chapter1/_index.md< / span > < / span > < / code > < / pre > < / div >
< / li >
< li >
< p > If ye be creat'n yer Marrrkdown files manually, ye can achieve th' same by just sett'n < code > type='chapter'< / code > 'n th' front matter.< / p >
< / li >
< / ul >
< p > Yer result'n Marrrkdown file needs t' have at least th' < code > type< / code > front matter set t' th' value o' th' plank design< / p >
2024-10-15 10:39:20 +00:00
< div class = "tab-panel" data-tab-group = "69a2ee3624b3093d923824f23cfa4d70" >
2024-10-13 14:26:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="_indexmd"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-15 10:39:20 +00:00
onclick="switchTab('69a2ee3624b3093d923824f23cfa4d70','_indexmd')"
2024-10-13 14:26:50 +00:00
>
< span class = "tab-nav-text" > _index.md< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="_indexmd"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Chapter 1" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > type< / span > < span class = "p" > =< / span > < span class = "s2" > " chapter" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div > < h2 id = "predefined-designs" > Predefined Designs< / h2 >
< h3 id = "archetypes-home" > Home< / h3 >
< p > A < strong > Home< / strong > plank be th' start'n plank o' yer project. It’ s best t' have only one plank o' this kind 'n yer project.< / p >
< p > T' create a home plank, run th' follow'n command< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind home _index.md< / span > < / span > < / code > < / pre > < / div >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-b45dbac7a458a0541cec6464973b8bf8" class = "lightbox-link" > < img alt = "Home page" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-home.png?width=60pc" style = " height: auto; width: 60pc;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-b45dbac7a458a0541cec6464973b8bf8" > < img alt = "Home page" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-home.png?width=60pc" > < / a > < / p >
2024-10-13 14:26:50 +00:00
< h3 id = "archetypes-chapter" > Chapter< / h3 >
< p > A < strong > Chapter< / strong > displays a plank meant t' be used as introduct'n fer a set o' child planks.< / p >
< p > Commonly, it contains a title front matter an' a short descript'n 'n th' rrrambl'n.< / p >
< p > T' create a chapter plank, run th' follow'n command< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind chapter chapter1/_index.md< / span > < / span > < / code > < / pre > < / div >
< p > If a numerical < code > weight< / code > front matter be set, it will be used t' generate th' subtitle o' th' chapter plank. Set th' number t' a consecutive value start'n at 1 fer each new chapter on th' same directory level.< / p >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-6e61b2e4b0c0c5a288b12ec5caf2fa91" class = "lightbox-link" > < img alt = "Chapter page" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-chapter.png?width=60pc" style = " height: auto; width: 60pc;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-6e61b2e4b0c0c5a288b12ec5caf2fa91" > < img alt = "Chapter page" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-chapter.png?width=60pc" > < / a > < / p >
2024-10-13 14:26:50 +00:00
< h3 id = "archetypes-default" > Default< / h3 >
< p > A < strong > Default< / strong > plank be any other rrrambl'n plank.< / p >
< p > T' create a default plank, run either one o' th' follow'n commands< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new chapter1/page1/_index.md< / span > < / span > < / code > < / pre > < / div >
< p > or< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new chapter1/page1.md< / span > < / span > < / code > < / pre > < / div >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-27d215bd05710ea194491137c11f0642" class = "lightbox-link" > < img alt = "Default page" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-default.png?width=60pc" style = " height: auto; width: 60pc;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-27d215bd05710ea194491137c11f0642" > < img alt = "Default page" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/designs/pages-default.png?width=60pc" > < / a > < / p >
2024-10-13 14:26:50 +00:00
2023-11-28 22:52:52 +00:00
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2024-10-13 14:26:50 +00:00
< h1 id = "navigation-menu" > Navigation Menu< / h1 >
2023-11-28 22:52:52 +00:00
2024-10-13 14:26:50 +00:00
< p > Th' navigat'n menu be automatically created from < a href = "/hugo-theme-relearn/pir/authoring/structure/index.html" > yer rrrambl'n files< / a > .< / p >
< p > All configurat'ns opt'ns apply t' all planks but can be changed 'n each page’ s front matter.< / p >
< h2 id = "expand-state-of-nested-sections" > Expand State o' Nested Sect'ns< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Ye can change how th' theme submenus appear wit' < code > alwaysopen< / code > .< / p >
< p > If < code > alwaysopen=false< / code > fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.< / p >
< p > Th' theme generates th' expand state based on th' follow'n rules:< / p >
< ul >
< li > all parent entries o' th' active plank includ'n their < a href = "/hugo-theme-relearn/pir/authoring/meta/index.html#hidden" > vis'ble< / a > sibl'ns be shown regardless o' any sett'ns< / li >
< li > immediate child entries o' th' active plank be shown regardless o' any sett'ns< / li >
< li > if not overridden, all other first level entries behave like they would have been given < code > alwaysopen=false< / code > < / li >
< li > if not overridden, all other entries o' levels besides th' first behave like they would have been given < code > alwaysopen=true< / code > < / li >
< li > all < a href = "/hugo-theme-relearn/pir/authoring/meta/index.html#hidden" > vis'ble< / a > entries show their immediate child entries if < code > alwaysopen=true< / code > ; this proceeds recursively< / li >
< li > all remain'n entries be not shown< / li >
< / ul >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > alwaysopen< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " alwaysopen" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "expander-for-nested-sections" > Expander fer Nested Sect'ns< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Set < code > collapsibleMenu=true< / code > t' add an expander fer submenus. This shows submenus as collaps'ble trees wit' a click'ble expander.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
2024-03-02 10:05:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-13 14:26:50 +00:00
onclick="switchTab('config-code','toml')"
2024-03-02 10:05:50 +00:00
>
< span class = "tab-nav-text" > toml< / span >
< / button >
2024-10-13 14:26:50 +00:00
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-03-02 10:05:50 +00:00
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > collapsibleMenu< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " collapsibleMenu" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< div class = "box notices cstyle warning" >
< div class = "box-label" >
< i class = "fa-fw fas fa-exclamation-triangle" > < / i > Arrr
< / div >
< div class = "box-content" >
< p > Us'n this opt'n may slow down yer build process, especially wit' many planks.< / p >
< p > We’ ve seen builds tak'n 2 minutes wit' 1000+ planks, an' over 30 minutes wit' 5000+ planks.< / p >
< p > This happens because each new plank affects all other planks, lead'n t' exponentially longer build times.< / p >
< / div >
< / div >
< h2 id = "ordering-sibling-menu-entries" > Order'n Sibl'n Menu Entries< / h2 >
< h3 id = "by-weight" > By Weight< / h3 >
< p > Cap'n Hugo provides a < a href = "https://gohugo.io/getting-started/glossary/#weight" rel = "external" target = "_self" > simple way< / a > t' handle order fer yer planks by sett'n th' < code > weight< / code > front matter t' a number.< / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' My page' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 5< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > title< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > My plank< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > weight< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "m" > 5< / span > < span class = "w" >
2024-09-05 18:03:19 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " My page" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " weight" < / span > < span class = "p" > :< / span > < span class = "mi" > 5< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "by-other" > By Other< / h3 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Us'n th' < code > weight< / code > fer sort'n can get cumbersome if ye, fer example, just want t' sort alphabetically. Each time ye add a new plank 'n th' set o' planks, ye may have t' renumber some or all o' them t' make space fer th' new plank.< / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > ordersectionsby< / span > < span class = "p" > =< / span > < span class = "s1" > ' linktitle' < / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > ordersectionsby< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > linktitle< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " ordersectionsby" < / span > < span class = "p" > :< / span > < span class = "s2" > " linktitle" < / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "custom-title-for-menu-entries" > Custom Title fer Menu Entries< / h2 >
< p > By default, th' Relearrrn theme will use a page’ s < code > title< / code > front matter fer th' menu entry.< / p >
< p > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > But a page’ s title has t' be descriptive on its own while th' menu be a hierarchy. Use < code > linkTitle< / code > t' shorten th' text o' th' menu entry.< / p >
< p > For example fer a plank named < code > install/linux.md< / code > < / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2024-03-02 10:05:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > linkTitle< / span > < span class = "p" > =< / span > < span class = "s1" > ' Linux' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' Install on Linux' < / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
2024-03-02 10:05:50 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > linkTitle< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > Linux< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > title< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > Install on Linux< / span > < span class = "w" >
2024-09-05 18:03:19 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-03-02 10:05:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " linkTitle" < / span > < span class = "p" > :< / span > < span class = "s2" > " Linux" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " Install on Linux" < / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "add-icon-to-a-menu-entry" > Add Ay'con t' a Menu Entry< / h2 >
< p > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > In th' plank front matter, add a < code > menuPre< / code > t' insert any HTML code before th' menu label. Ye can also set < code > menuPost< / code > t' insert HTML code after th' menu label.< / p >
< p > Th' example below uses th' GitHub ay'con.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > menuPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' < i class=" fab fa-github" > < /i> ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' GitHub Repo' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > menuPre< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s1" > ' < i class=" fab fa-github" > < /i> ' < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > title< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > GitHub Repo< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " menuPre" < / span > < span class = "p" > :< / span > < span class = "s2" > " \u003ci class=\" fab fa-github\" \u003e\u003c/i\u003e " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " GitHub Repo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< / div >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-9cc3392d5ffec691f31632f4d17a3748" class = "lightbox-link" > < img alt = "Title wit' icon" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/navigationmenu/item-with-icon.png?width=18.75rem" style = " height: auto; width: 18.75rem;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-9cc3392d5ffec691f31632f4d17a3748" > < img alt = "Title wit' icon" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "/hugo-theme-relearn/authoring/frontmatter/navigationmenu/item-with-icon.png?width=18.75rem" > < / a > < / p >
2023-09-21 15:25:13 +00:00
< h2 id = "disable-section-pages" > Dis'ble Sect'n Planks< / h2 >
2024-04-12 15:30:57 +00:00
< p > Ye may want t' structure yer planks 'n a hierarchical way but don’ t want t' generate planks fer those sections? Th' theme got ye covered.< / p >
2024-10-13 14:26:50 +00:00
< p > T' stay wit' th' < a href = "/hugo-theme-relearn/pir/authoring/structure/index.html" > initial example< / a > : Suppose ye want < code > first-chapter/first-page< / code > appear 'n th' sidebar but don’ t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.< / p >
< p > For this, open < code > content/first-chapter/first-page/_index.md< / code > an' add th' follow'n front matter< / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2024-03-02 10:05:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-09-21 15:25:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > _build< / span > < span class = "p" > ]< / span >
2024-03-02 10:05:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > render< / span > < span class = "p" > =< / span > < span class = "s1" > ' never' < / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
2024-03-02 10:05:50 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > _build< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > render< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > never< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > collapsibleMenu< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
2024-09-05 18:03:19 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-03-02 10:05:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " _build" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " render" < / span > < span class = "p" > :< / span > < span class = "s2" > " never" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " collapsibleMenu" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-04-24 21:05:57 +00:00
2022-04-02 13:30:16 +00:00
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
2024-04-07 19:58:38 +00:00
2024-10-13 14:26:50 +00:00
< h1 id = "linking" > Linking< / h1 >
2022-04-02 13:30:16 +00:00
2024-10-13 14:26:50 +00:00
< h2 id = "opening-links" > Open'n Links< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > By default, external links open 'n a new tab. T' change this, use th' < code > externalLinkTarget< / code > sett'n wit' a proper < a href = "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#target" rel = "external" target = "_self" > link target< / a > .< / p >
< p > For example, this will open links 'n th' same tab< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
2024-03-02 10:05:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2024-10-13 14:26:50 +00:00
data-tab-item="toml"
2024-03-02 10:05:50 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-13 14:26:50 +00:00
onclick="switchTab('config-code','toml')"
2024-03-02 10:05:50 +00:00
>
2024-10-13 14:26:50 +00:00
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
2024-03-02 10:05:50 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2024-10-13 14:26:50 +00:00
data-tab-item="toml"
2024-03-02 10:05:50 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > externalLinkTarget< / span > < span class = "p" > =< / span > < span class = "s1" > ' _self' < / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > externalLinkTarget< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > _self< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " externalLinkTarget" < / span > < span class = "p" > :< / span > < span class = "s2" > " _self" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< h2 id = "enabling-link-and-image-link-warnings" > Enabl'n Link an' Image Link Warn'ns< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Ye can use < code > link.errorlevel< / code > an' < code > image.errorlevel< / code > t' control what should happen if a local link can not be resolved t' a resource.< / p >
< p > If not set or empty, any unresolved link be written as given into th' result'n output. If set t' < code > warning< / code > th' same happens an' an additional warning be printed 'n th' built console. If set t' < code > error< / code > an error message be printed an' th' build be aborted.< / p >
< p > Please note that this can not resolve files inside o' yer < code > static< / code > directory. Th' file must be a resource o' th' plank or th' ship.< / p >
< p > Link warnings be also avail'ble fer th' < a href = "/hugo-theme-relearn/pir/shortcodes/include/index.html#enabling-link-warnings" > include< / a > an' < a href = "/hugo-theme-relearn/pir/shortcodes/openapi/index.html#enabling-link-warnings" > openapi< / a > shorrrtcodes.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
2024-03-02 10:05:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2024-10-13 14:26:50 +00:00
data-tab-item="toml"
2024-03-02 10:05:50 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-13 14:26:50 +00:00
onclick="switchTab('config-code','toml')"
2024-03-02 10:05:50 +00:00
>
2024-10-13 14:26:50 +00:00
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
2024-03-02 10:05:50 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2024-10-13 14:26:50 +00:00
data-tab-item="toml"
2024-03-02 10:05:50 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < 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" > image< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' warning' < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > link< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' warning' < / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > image< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > warning< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > link< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > warning< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " image" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " warning" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " link" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " warning" < / 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 >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "topbarrr" > Topbarrr< / h1 >
< p > This plank be about how t' configure th' topbar us'n configurat'n opt'ns. If ye want t' add further buttons or functionality, < a href = "/hugo-theme-relearn/pir/configuration/customization/topbar/index.html" > see this section< / a > .< / p >
< p > Yer topbar contains th' follow'n elements. Some o' them be configuar'ble:< / p >
< ul >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-bars" > < / i > < / span > < / span > < strong > sidebar< / strong > : opens th' sidebar flyout if 'n mobile layout< / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-list-alt" > < / i > < / span > < / span > < strong > toc< / strong > : < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#table-of-contents" > opens th' t'ble o' contents 'n an overlay< / a > < / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-empty" > < / i > < / span > < / span > < strong > breadcrumb< / strong > : shows th' click'ble < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#breadcrumbs" > breadcrumbs< / a > < / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-pen" > < / i > < / span > < / span > < strong > edit< / strong > : browses t' th' edit'ble plank if th' < code > editURL< / code > < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#edit-button" > parameter be set< / a > < / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-print" > < / i > < / span > < / span > < strong > print< / strong > : browses t' th' chapters print'ble plank if < a href = "/hugo-theme-relearn/pir/configuration/sitemanagement/outputformats/index.html#print-support" > print support< / a > was activated< / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-chevron-left" > < / i > < / span > < / span > < strong > prev< / strong > : browses t' th' < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#arrow-navigation" > previous plank< / a > if there be one< / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-chevron-right" > < / i > < / span > < / span > < strong > next< / strong > : browses t' th' < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/topbar/index.html#arrow-navigation" > next plank< / a > if there be one< / li >
< li > < span class = "btn cstyle transparent" > < span > < i class = "fa-fw fas fa-ellipsis-v" > < / i > < / span > < / span > < strong > more< / strong > : opens th' overlay if screen space be limited< / li >
< / ul >
< h2 id = "table-of-contents" > T'ble o' Contents< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Set < code > disableToc=true< / code > t' hide th' TOC button on all planks. If th' button be hidden, also th' keyboard shortcut be disabled. This can be overridden 'n a page’ s front matter.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
2024-03-02 10:05:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2024-10-13 14:26:50 +00:00
data-tab-item="toml"
2024-03-02 10:05:50 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-13 14:26:50 +00:00
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
2024-03-02 10:05:50 +00:00
>
2024-10-13 14:26:50 +00:00
< span class = "tab-nav-text" > json< / span >
2024-03-02 10:05:50 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2024-10-13 14:26:50 +00:00
data-tab-item="toml"
2024-03-02 10:05:50 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > disableToc< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > disableToc< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " disableToc" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< h2 id = "breadcrumbs" > Breadcrumbs< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Set < code > disableBreadcrumb=true< / code > t' hide th' breadcrumb 'n th' topbar.< / p >
< p > Further breadcrumbs sett'ns can be found 'n th' < a href = "/hugo-theme-relearn/pir/configuration/content/titles/index.html" > rrrambl'n configurat'n section< / a > .< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
2024-03-02 10:05:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2024-10-13 14:26:50 +00:00
data-tab-item="toml"
2024-03-02 10:05:50 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-13 14:26:50 +00:00
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
2024-03-02 10:05:50 +00:00
>
2024-10-13 14:26:50 +00:00
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
2024-03-02 10:05:50 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2024-10-13 14:26:50 +00:00
data-tab-item="toml"
2024-03-02 10:05:50 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > disableBreadcrumb< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > disableBreadcrumb< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " disableBreadcrumb" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2023-05-19 18:46:07 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "edit-button" > Edit Button< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > If < code > editURL< / code > be set t' a URL, an edit button will be shown 'n th' topbar. If th' button be hidden, also th' keyboard shortcut be disabled.< / p >
< p > Th' value can contain th' macro < code > ${FilePath}< / code > which will be replaced by th' file path o' yer displayed plank. If no < code > ${FilePath}< / code > be given 'n th' value, th' value be treated as if th' < code > ${FilePath}< / code > was appended at th' end o' th' value. This can be overridden 'n th' planks front matter.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > editURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}' < / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > editURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " editURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/${FilePath}" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "arrow-navigation" > Arrow Navigat'n< / h2 >
< p > < span class = "badge cstyle cyan badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-gears" > < / i > < / span > < span class = "badge-content" > Opt'n< / span > < / span > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Ye can hide th' previous/next buttons by sett'n < code > disableNextPrev=true< / code > . If th' buttons be hidden, also th' keyboard shortcuts be disabled.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > disableNextPrev< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > disableNextPrev< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " disableNextPrev" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "front-matter-reference" > Front Matter Reference< / h1 >
< p > Every Cap'n Hugo plank must have front matter.< / p >
< p > In addit'n t' < a href = "https://gohugo.io/content-management/front-matter/#fields" rel = "external" target = "_self" > Hugo’ s standard front matter< / a > , th' Relearrrn theme offers extras sett'ns listed here.< / p >
< p > Throughout th' documentat'n, theme-specific front matter be marked wit' a < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > badge.< / p >
< p > Add theme front matter directly t' th' root o' yer page’ s front matter. For example:< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > math< / 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 >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > math< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " math" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "index" > Index< / h2 >
< h3 id = "a" > A< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/alwaysopen/index.html" > Alwaysopen< / a > (1)< / li >
< / ul >
< h3 id = "c" > C< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/collapsiblemenu/index.html" > CollapsibleMenu< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/custommathjaxurl/index.html" > CustomMathJaxURL< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/custommermaidurl/index.html" > CustomMermaidURL< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/customopenapiurl/index.html" > CustomOpenapiURL< / a > (1)< / li >
< / ul >
< h3 id = "d" > D< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/description/index.html" > Descript'n< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/disablebreadcrumb/index.html" > DisableBreadcrumb< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/disablenextprev/index.html" > DisableNextPrev< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/disabletoc/index.html" > DisableToc< / a > (1)< / li >
< / ul >
< h3 id = "e" > E< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/editurl/index.html" > EditURL< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/externallinktarget/index.html" > ExternalLinkTarget< / a > (1)< / li >
< / ul >
< h3 id = "h" > H< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/headingpost/index.html" > HeadingPost< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/headingpre/index.html" > HeadingPre< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/hidden/index.html" > Hidden< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/highlightwrap/index.html" > HighlightWrap< / a > (1)< / li >
< / ul >
< h3 id = "i" > I< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/image.errorlevel/index.html" > Image.errorlevel< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/imageeffects/index.html" > ImageEffects< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/include.errorlevel/index.html" > Include.errorlevel< / a > (1)< / li >
< / ul >
< h3 id = "l" > L< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/lastmodifierdisplayname/index.html" > LastModifierDisplayName< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/lastmodifieremail/index.html" > LastModifierEmail< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/link.errorlevel/index.html" > Link.errorlevel< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/linktitle/index.html" > LinkTitle< / a > (1)< / li >
< / ul >
< h3 id = "m" > M< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/math/index.html" > Math< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/math.force/index.html" > Math.force< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/mathjaxinitialize/index.html" > MathJaxInitialize< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/menupost/index.html" > MenuPost< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/menupre/index.html" > MenuPre< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/mermaid.force/index.html" > Merrrmaid.force< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/mermaidinitialize/index.html" > MermaidInitialize< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/mermaidzoom/index.html" > MermaidZoom< / a > (1)< / li >
< / ul >
< h3 id = "o" > O< / h3 >
< ul class = "columnize" >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/openapi.errorlevel/index.html" > Openapi.errorlevel< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/openapi.force/index.html" > Openapi.force< / a > (1)< / li >
< li > < a href = "/hugo-theme-relearn/pir/frontmatter/ordersectionsby/index.html" > Ordersectionsby< / a > (2)< / li >
< / ul >
< h2 id = "all-front-matter" > All Front Matter< / h2 >
< p > Here’ s a list o' all avail'ble front matter wit' example values. Default values be described 'n th' < a href = "/hugo-theme-relearn/pir/authoring/frontmatter/reference/index.html#annotated-front-matter" > annotated example< / a > below or 'n each front matter’ s documentat'n.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > LastModifierDisplayName< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierEmail< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMathJaxURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMermaidURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customOpenapiURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > descript'n< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableBreadcrumb< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableNextPrev< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableToc< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > editURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > externalLinkTarget< / span > < span class = "p" > =< / span > < span class = "s1" > ' _self' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPost< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > hidden< / span > < span class = "p" > =< / span > < span class = "kc" > false< / 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 = "nx" > images< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s1" > ' images/hero.png' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > linkTitle< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > math< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mathJaxInitialize< / span > < span class = "p" > =< / span > < span class = "s1" > ' {}' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPost< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidInitialize< / span > < span class = "p" > =< / span > < span class = "s1" > ' { " securityLevel" : " loose" }' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidZoom< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > ordersectionsby< / span > < span class = "p" > =< / span > < span class = "s1" > ' weight' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' Example Page' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > type< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > image< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > imageEffects< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lazy< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lightbox< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > shadow< / 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 = "p" > [< / span > < span class = "nx" > include< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > link< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > mermaid< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > force< / 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 = "p" > [< / span > < span class = "nx" > openapi< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > oppenapi< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > force< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > LastModifierDisplayName< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > LastModifierEmail< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > alwaysopen< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > collapsibleMenu< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > customMathJaxURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > customMermaidURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > customOpenapiURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > descript'n< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > disableBreadcrumb< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > disableNextPrev< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > disableToc< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > editURL< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > externalLinkTarget< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > _self< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > headingPost< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > headingPre< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > hidden< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > highlightWrap< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > image< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > imageEffects< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > border< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > lazy< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > lightbox< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > shadow< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > images< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > - < span class = "l" > images/hero.png< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > include< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > link< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > linkTitle< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > math< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > mathJaxInitialize< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s1" > ' {}' < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > menuPost< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > menuPre< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > mermaid< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > force< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > mermaidInitialize< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s1" > ' { " securityLevel" : " loose" }' < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > mermaidZoom< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > openapi< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > errorlevel< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > oppenapi< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > force< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > ordersectionsby< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > weight< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > title< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > Example Plank< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > type< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s2" > " " < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " LastModifierDisplayName" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " LastModifierEmail" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " alwaysopen" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " collapsibleMenu" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " customMathJaxURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " customMermaidURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " customOpenapiURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " description" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " disableBreadcrumb" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " disableNextPrev" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " disableToc" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " editURL" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " externalLinkTarget" < / span > < span class = "p" > :< / span > < span class = "s2" > " _self" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " headingPost" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " headingPre" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " hidden" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " highlightWrap" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " image" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " imageEffects" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " border" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " lazy" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " lightbox" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " shadow" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " images" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s2" > " images/hero.png" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ],< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " include" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " link" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " linkTitle" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " math" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " mathJaxInitialize" < / span > < span class = "p" > :< / span > < span class = "s2" > " {}" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " menuPost" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " menuPre" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " mermaid" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " force" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " mermaidInitialize" < / span > < span class = "p" > :< / span > < span class = "s2" > " { \" securityLevel\" : \" loose\" }" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " mermaidZoom" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " openapi" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " errorlevel" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " oppenapi" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " force" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " ordersectionsby" < / span > < span class = "p" > :< / span > < span class = "s2" > " weight" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " Example Page" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " type" < / span > < span class = "p" > :< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-08-13 11:44:38 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "annotated-front-matter" > Annotated Front Matter< / h2 >
2024-10-15 10:39:20 +00:00
< div class = "tab-panel" data-tab-group = "deae793687c7b04f68bbd81c055c39dc" >
2024-10-13 14:26:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-15 10:39:20 +00:00
onclick="switchTab('deae793687c7b04f68bbd81c055c39dc','toml')"
2024-10-13 14:26:50 +00:00
>
< span class = "tab-nav-text" > toml< / span >
< / button >
2024-09-05 18:03:19 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "c" > # If an opt'n value be said t' be not set, ye can achieve th' same behavior< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # by giv'n it an empty str'n value.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > ###############################################################################< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Cap'n Hugo< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns usually apply t' other themes as well.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' social media image o' yer plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This be used fer generat'n social media meta informat'n fer th' opengraph< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # protocol an' twitter cards.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > images< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s1" > ' images/hero.png' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' yer plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # A plank without a title be treated as a hidden plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' Example Page' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' descript'n o' yer plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This be used fer generat'n HTML meta tags, social media meta informat'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # fer th' opengraph protocol an' twitter cards.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used fer th' html< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # meta tag, social media meta informat'n fer th' opengraph protocol an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # twitter cards.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > descript'n< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' plank design t' be used< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This decides th' layout o' yer plank. Th' theme ships ' home' , ' chapter' an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # ' default' . If not set, ' default' be taken.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > type< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > ###############################################################################< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Relearrrn Theme< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns be specific t' th' Relearrrn theme.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Topbar< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns modify th' topbar appearance.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide th' t'ble o' contents button.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If th' TOC button be hidden, also th' keyboard shortcut be disabled.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableToc< / 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" > # Hide th' breadcrumbs.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # shown 'n th' topbar.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableBreadcrumb< / 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" > # Hide Next an' Previous navigat'n buttons.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # disabled.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableNextPrev< / 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' URL prefix t' edit a plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set, an edit button will be shown 'n th' topbar. If th' button be hidden,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # also th' keyboard shortcuts be disabled. Th' value can contain th' macro< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # `${FilePath}` which will be replaced by th' file path o' yer displayed plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used. If th' global< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # parameter be given but ye want t' hide th' button fer th' displayed plank,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # ye can set th' value t' an empty str'n. If instead o' hid'n ye want t' have< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # an disabled button, ye can set th' value t' a str'n contain'n just spaces.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This be useful if ye want t' give th' opportunity fer people t' create merge< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # request fer yer rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > editURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Menu< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns modify th' menu appearance.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Menu specific title< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title displayed 'n th' menu. If not set th' `title` front matter will< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > linkTitle< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Prefix fer th' title 'n navigat'n menu.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Suffix fer th' title 'n navigat'n menu.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPost< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' order o' navigat'n menu submenus.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' weight' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Submenus can be ordered by ' weight' , ' title' , ' linktitle' , ' modifieddate' ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # ' expirydate' , ' publishdate' , ' date' , ' length' or ' default' (adher'n t'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hugo' s default sort order).< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' value o' th' parent menu entry be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > ordersectionsby< / span > < span class = "p" > =< / span > < span class = "s1" > ' weight' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' initial expand state o' submenus.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This controls whether submenus will be expanded (true), or collapsed (false)< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # 'n th' menu. If not set, th' first menu level be set t' false, all others< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # levels be set t' true. If not set, th' value o' th' parent menu entry be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If th' displayed plank has submenus, they will always been displayed expanded< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # regardless o' this opt'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Shows expander fer submenus.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # tree view an' a click'ble expander be set 'n front o' th' entry.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hidden planks< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how hidden planks be treated.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # A plank flagged as hidden, be only removed from th' navigat'n menu if ye be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # currently not on this plank or th' hidden plank be not part o' current page' s< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # other plank if not otherwise configured.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide a page' s menu entry.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If this value be true, th' plank be hidden from th' menu.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > hidden< / 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" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Rrrambl'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns modify how yer rrrambl'n be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Prefix fer th' title 'n th' rrrambl'n area.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Suffix fer th' title 'n th' rrrambl'n area.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank head'n will be suffixed by this HTML rrrambl'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPost< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Display name o' th' page' s last editor.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set, it will be displayed 'n th' default footer.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierDisplayName< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Email address o' th' page' s last editor.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set together wit' LastModifierDisplayName, it will be displayed 'n th'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # default footer.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierEmail< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Highlight< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how code be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Wrap fer code blocks.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # By default lines o' code blocks wrap around if th' line be too long t' be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # displayed on screen. If ye dislike this behavior, ye can reconfigure it< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # here.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Avast that lines always wrap 'n print mode regardless o' this opt'n.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used or given as a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # parameter t' individual code blocks.< / 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 > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Include< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how th' include shortcode works.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # What t' do when path be not resolved.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Ye can control what should happen if a path can not be resolved t' as< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # a resource or via th' file system. If not set, no output will be written< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # fer th' unresolved path. If set t' `warning` th' same happens an' an additional< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # warning be printed. If set t' `error` an error message be printed an' th' build< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be aborted.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > include< / span > < span class = "p" > .< / span > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Images< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how images be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # What t' do when local image link be not resolved.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Ye can control what should happen if a local image can not be resolved t' as< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # a resource. If not set, th' unresolved link be written as given into th' result'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # output. If set t' `warning` th' same happens an' an additional warning be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # printed. If set t' `error` an error message be printed an' th' build be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # aborted.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Please note that this can not resolve files inside o' yer `static` directory.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > image< / span > < span class = "p" > .< / span > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Image effects.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # See th' documentat'n fer how ye can even add yer own arbitrary effects t'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # th' list.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # All effect values default t' th' values o' yer site' s hugo.toml an' can be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # overridden through URL parameter given t' th' image. See th' documentat'n fer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # details.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > imageEffects< / span > < span class = "p" > .< / span > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > imageEffects< / span > < span class = "p" > .< / span > < span class = "nx" > lazy< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > imageEffects< / span > < span class = "p" > .< / span > < span class = "nx" > lightbox< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > imageEffects< / span > < span class = "p" > .< / span > < span class = "nx" > shadow< / 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" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Links< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how links be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # What t' do when local plank link be not resolved.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Ye can control what should happen if a local link can not be resolved t' a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # plank. If not set, th' unresolved link be written as given into th' result'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # output. If set t' `warning` th' same happens an' an additional warning be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # printed. If set t' `error` an error message be printed an' th' build be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # aborted.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Please note that wit' Cap'n Hugo < 0.123.0 + `uglyURLs=true` this can lead t' false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # negatives.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > link< / span > < span class = "p" > .< / span > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # How t' open external links.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' _blank' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # For external links ye can define how they be opened 'n yer browser. All< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # default value opens external links 'n a separate browser tab. If ye want< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # t' open those links 'n th' same tab, use ' _self' .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > externalLinkTarget< / span > < span class = "p" > =< / span > < span class = "s1" > ' _self' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # MathJax< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how math formulae be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Initializat'n opt'ns fer MathJax.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mathJaxInitialize< / span > < span class = "p" > =< / span > < span class = "s1" > ' {}' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Force board Math on every plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If a, Math shortcode or codefence be found, th' opt'n will be ignored an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Math will be boarded regardlessly. This opt'n be useful 'n case ye< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be us'n passthrough configurat'n t' render yer math. In this case no shortcode or< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # codefence be involved an' th' library be not boarded by default so ye can< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # force load'n it by sett'n `math=true`.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This opt'n has an alias `math.force`.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > math< / 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" > # URL fer external MathJax library.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # version will be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMathJaxURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span > < span class = "c" > # ' https://unpkg.com/mathjax/es5/tex-mml-chtml.js' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Merrrmaid< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how Merrrmaid graphs be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Make graphs pan'ble an' zoom'ble< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # wit' a reset button fer th' zoom.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used or given as a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # parameter t' individual graphs.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidZoom< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Initializat'n opt'ns fer Merrrmaid.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidInitialize< / span > < span class = "p" > =< / span > < span class = "s1" > ' { " securityLevel" : " loose" }' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Force board Merrrmaid on every plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Merrrmaid will be boarded regardlessly. This opt'n be useful 'n case ye< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be us'n script'n t' render yer graph. In this case no shortcode or< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # codefence be involved an' th' library be not boarded by default so ye can< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # force load'n it by sett'n `mermaid.force=true`.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaid< / span > < span class = "p" > .< / span > < span class = "nx" > force< / 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" > # URL fer external Merrrmaid library.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # version will be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMermaidURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span > < span class = "c" > # ' https://unpkg.com/mermaid/dist/mermaid.min.js' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # OpenApi< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # These opt'ns configure how OpenAPI specificat'ns be displayed.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Board OpenAPI on every plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If a, OpenAPI shortcode or codefence be found, th' opt'n will be ignored an'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # OpenAPI will be boarded regardlessly. This opt'n be useful 'n case ye< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # be us'n script'n t' render yer spec. In this case no shortcode or< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # codefence be involved an' th' library be not boarded by default so ye can< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # force load'n it by sett'n `openapi.force=true`.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > oppenapi< / span > < span class = "p" > .< / span > < span class = "nx" > force< / 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" > # URL fer external OpenAPI library.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: not set< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # version will be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customOpenapiURL< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span > < span class = "c" > # ' https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # What t' do when a local OpenAPI spec link be not resolved.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Default: ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Ye can control what should happen if a local OpenAPI spec link can not be resolved< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # t' a resource. If not set, th' unresolved link be written as given into th' result'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # output. If set t' `warning` th' same happens an' an additional warning be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # printed. If set t' `error` an error message be printed an' th' build be< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # aborted.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Please note that this can not resolve files inside o' yer `static` directory.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If not set, th' set value o' yer site' s hugo.toml be used.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > openapi< / span > < span class = "p" > .< / span > < span class = "nx" > errorlevel< / span > < span class = "p" > =< / span > < span class = "s1" > ' ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/reference/index.html" > Reference< / a > < / li >
< / ul >
2024-09-03 17:09:09 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< / footer >
< / article >
< / section >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "meta-information" > Meta Information< / h1 >
< h2 id = "page-title" > Plank Title< / h2 >
< p > Th' < code > title< / code > will be used 'n th' head'n an' meta informat'n o' yer HTML.< / p >
< p > A plank without a title be < a href = "/hugo-theme-relearn/pir/authoring/meta/index.html#hidden" > treated as if < code > hidden=true< / code > < / a > has been set.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > title< / span > < span class = "p" > =< / span > < span class = "s1" > ' Example Title' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > title< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > Example Title< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " Example Title" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "page-description" > Plank Descript'n< / h2 >
< p > Th' < code > descript'n< / code > be used fer generat'n HTML meta informat'n, 'n th' < a href = "/hugo-theme-relearn/pir/shortcodes/children/index.html" > children< / a > shortcode an' 'n social media meta informat'n.< / p >
< p > If not set, th' set value o' yer site’ s hugo.toml be used fer th' HTML meta informat'n an' social media meta informat'n. It appears empty fer th' < a href = "/hugo-theme-relearn/pir/shortcodes/children/index.html" > children< / a > shortcode.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > descript'n< / span > < span class = "p" > =< / span > < span class = "s1" > ' Some lenghty example description' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > descript'n< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > Some lenghty example descript'n< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " description" < / span > < span class = "p" > :< / span > < span class = "s2" > " Some lenghty example description" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "social-media-images" > Social Media Images< / h2 >
< p > Th' theme adds social media meta tags includ'n feature images fer th' < a href = "https://gohugo.io/templates/internal/#open-graph" rel = "external" target = "_self" > Open Graph< / a > protocol an' < a href = "https://gohugo.io/templates/internal/#twitter-cards" rel = "external" target = "_self" > Twitter Cards< / a > t' yer ship. These be configured as mentioned 'n th' linked Cap'n Hugo docs.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > images< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s1" > ' images/hero.png' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > images< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > - < span class = "l" > images/hero.png< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " images" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s2" > " images/hero.png" < / 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 >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "hidden" > Hidden< / h2 >
< p > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > Ye can hide yer planks from th' menu by sett'n < code > hidden=true< / code > .< / p >
< p > < a href = "/hugo-theme-relearn/pir/configuration/content/hidden/index.html" > See how ye can further configure visibility< / a > throughout yer ship.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > hidden< / 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 >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > hidden< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " hidden" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-05-28 17:52:29 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "add-icon-to-the-title-heading" > Add Ay'con t' th' Title Head'n< / h2 >
< p > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > In th' plank front matter, add a < code > headingPre< / code > t' insert any HTML code before th' title head'n. Ye can also set < code > headingPost< / code > t' insert HTML code after th' title head'n.< / p >
< p > Ye also may want t' < a href = "/hugo-theme-relearn/pir/configuration/customization/dependencies/index.html#adding-javascript-or-stylesheets-to-all-pages" > apply further CSS< / a > 'n this case.< / p >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > headingPre< / span > < span class = "p" > =< / span > < span class = "s1" > ' < i class=" fab fa-github" > < /i> ' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > headingPre< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "s1" > ' < i class=" fab fa-github" > < /i> ' < / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " headingPre" < / span > < span class = "p" > :< / span > < span class = "s2" > " \u003ci class=\" fab fa-github\" \u003e\u003c/i\u003e " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-04-04 21:31:21 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "footer-information" > Footer Informat'n< / h2 >
< p > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > If ye use th' default < code > layouts/partials/content-footer.html< / code > be not overridden by ye, it will display author'n informat'n, namely< / p >
< ul >
< li > < code > AuthorName< / code > if < a href = "https://gohugo.io/methods/page/gitinfo/" rel = "external" target = "_self" > GitInfo< / a > be active, otherwise < code > LastModifierDisplayName< / code > front matter< / li >
< li > < code > AuthorEmail< / code > if < a href = "https://gohugo.io/methods/page/gitinfo/" rel = "external" target = "_self" > GitInfo< / a > be active, otherwise < code > LastModifierEmail< / code > front matter< / li >
< li > < code > AuthorDate< / code > if < a href = "https://gohugo.io/methods/page/gitinfo/" rel = "external" target = "_self" > GitInfo< / a > be active, otherwise < a href = "https://gohugo.io/methods/page/date/" rel = "external" target = "_self" > Hugo’ s < code > date< / code > front matter< / a > < / li >
< / ul >
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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" > LastModifierDisplayName< / span > < span class = "p" > =< / span > < span class = "s1" > ' Santa Claus' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierEmail< / span > < span class = "p" > =< / span > < span class = "s1" > ' santa@example.com' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > date< / span > < span class = "p" > =< / span > < span class = "ld" > 2000-12-24T00:00:00-12:00< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > LastModifierDisplayName< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > Santa Claus< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > LastModifierEmail< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "l" > santa@example.com< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > date< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "ld" > 2000-12-24T00:00:00< / span > < span class = "m" > -12< / span > < span class = "p" > :< / span > < span class = "m" > 00< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
< div class = "highlight wrap-code" > < 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 = "nt" > " LastModifierDisplayName" < / span > < span class = "p" > :< / span > < span class = "s2" > " Santa Claus" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " LastModifierEmail" < / span > < span class = "p" > :< / span > < span class = "s2" > " santa@example.com" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " date" < / span > < span class = "p" > :< / span > < span class = "s2" > " 2000-12-24T00:00:00-12:00" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< / ul >
2024-04-04 21:31:21 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "marrrkdown-rules" > Marrrkdown Rules< / h1 >
< p > Let’ s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.< / p >
< p > < strong > Marrrkdown< / strong > be a better way t' write < strong > HTML< / strong > , without all th' complexities an' ugliness that usually accompanies it.< / p >
< p > Some o' th' key benefits be:< / p >
< ol >
< li > Marrrkdown be simple t' learn, wit' minimal extra characters so it’ s also quicker t' write rrrambl'n.< / li >
< li > Less chance o' errors when writ'n 'n Marrrkdown.< / li >
< li > Produces valid HTML output.< / li >
< li > Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship.< / li >
< li > Write 'n any text editor or Marrrkdown applicat'n ye like.< / li >
< li > Marrrkdown be a joy t' use!< / li >
< / ol >
< p > John Gruber, th' author o' Marrrkdown, puts it like this:< / p >
< blockquote >
< p > Th' overrid'n design goal fer Markdown’ s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’ s been marked up wit' tags or formatt'n instruct'ns. While Markdown’ s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’ s rules be th' format o' plain text email.
< cite > John Gruber< / cite > < / p >
< / blockquote >
< div class = "box notices cstyle tip" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-lightbulb" > < / i > Smarrrt Arrrse
2024-09-01 11:58:33 +00:00
< / div >
2024-04-04 21:31:21 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > < i class = "fa-fw fas fa-bookmark" > < / i > Bookmark this plank fer easy future reference!< / p >
2024-09-05 18:03:19 +00:00
< / div >
2024-04-04 21:31:21 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "standard-and-extensions" > Standard an' Extensions< / h2 >
< p > If not otherwise noted, th' shown examples adhere t' th' < a href = "https://commonmark.org/help/" rel = "external" target = "_self" > CommonMark< / a > standard. In addit'n th' theme supports th' follow'n extensions that < a href = "https://gohugo.io/getting-started/configuration-markup/#goldmark" rel = "external" target = "_self" > can be activated< / a > 'n yer < code > hugo.toml< / code > or be built into th' theme:< / p >
2022-12-02 15:05:54 +00:00
< ul >
2024-10-13 14:26:50 +00:00
< li >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-github" > < / i > < / span > < span class = "badge-content" style = "background-color: darkgray;" > GFM< / span > < / span > Extension on top o' standard Marrrkdown adher'n t' < a href = "https://github.github.com/gfm/" rel = "external" target = "_self" > GitHub Flavored Marrrkdown< / a > .< / p >
2022-12-02 15:05:54 +00:00
< / li >
2024-10-13 14:26:50 +00:00
< li >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-php" > < / i > < / span > < span class = "badge-content" style = "background-color: #888cc4;" > PHP< / span > < / span > Extension on top o' standard Marrrkdown adher'n t' < a href = "https://michelf.ca/projects/php-markdown/extra/" rel = "external" target = "_self" > PHP Marrrkdown< / a > .< / p >
< / li >
< li >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-lightbulb" > < / i > < / span > < span class = "badge-content" style = "background-color: darkorange;" > Pants< / span > < / span > Extension by John Gruber adher'n t' < a href = "https://daringfireball.net/projects/smartypants/" rel = "external" target = "_self" > SmartyPants< / a > .< / p >
< / li >
< li >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > Cap'n Hugo< / span > < / span > < a href = "https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel = "external" target = "_self" > Cap'n Hugo Extra Extension< / a > supported by Cap'n Hugo.< / p >
< / li >
< li >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw far fa-gem" > < / i > < / span > < span class = "badge-content" style = "background-color: #7c3aed;" > Obsidian< / span > < / span > Extension implemented by < a href = "https://obsidian.md/" rel = "external" target = "_self" > Obsidian< / a > .< / p >
< / li >
< li >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-code" > < / i > < / span > < span class = "badge-content" style = "background-color: orangered;" > HTML< / span > < / span > If th' < a href = "https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel = "external" target = "_self" > usage o' HTML< / a > be allowed, th' theme supports styl'n fer further HTML elements.< / p >
< / li >
< li >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-puzzle-piece" > < / i > < / span > < span class = "badge-content" style = "background-color: #7dc903;" > Relearrrn< / span > < / span > Extension specific t' this theme.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< / ul >
2024-10-13 14:26:50 +00:00
< h2 id = "paragraphs" > Paragraphs< / h2 >
< p > In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.< / p >
< p > Any text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.< / p >
< p > Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "headings" > Head'ns< / h2 >
< p > A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from < code > h1< / code > through < code > h6< / code > be constructed wit' a < code > #< / code > fer each level.< / p >
< p > In Hugo ye usually don’ t use < code > h1< / code > as this be generated by yer theme an' ye should only have one such element 'n a document.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > < span class = "gh" > # h1 Head'n
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gh" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ## h2 Head'n
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ### h3 Head'n
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > #### h4 Head'n
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ##### h5 Head'n
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > ###### h6 Head'n< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< h1 id = "h1-heading" > h1 Head'n< / h1 >
< h2 id = "h2-heading" > h2 Head'n< / h2 >
< h3 id = "h3-heading" > h3 Head'n< / h3 >
< h4 id = "h4-heading" > h4 Head'n< / h4 >
< h5 id = "h5-heading" > h5 Head'n< / h5 >
< h6 id = "h6-heading" > h6 Head'n< / h6 >
2024-09-05 18:03:19 +00:00
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "horizontal-rules" > Horizontal Rules< / h2 >
< p > T' further structure yer rrrambl'n ye can add horizontal rules. They create a “ thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes < code > ---< / code > .< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ---
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.< / p >
< hr >
< p > Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "blockquotes" > Blockquotes< / h2 >
< h3 id = "quotations" > Quotat'ns< / h3 >
< p > For quot'n blocks o' rrrambl'n from another source within yer document add < code > > < / code > before any text ye want t' quote.< / p >
< p > Blockquotes can also be nested.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > < / span > < span class = "ge" > > > Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > >
< / span > < / span > < span class = "line" > < span class = "cl" > > Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< blockquote >
< p > Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.< / p >
< blockquote >
< p > Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.< / p >
< / blockquote >
< p > Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.< / p >
< / blockquote >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "github-alerts" > GitHub Alerts< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-github" > < / i > < / span > < span class = "badge-content" style = "background-color: darkgray;" > GFM< / span > < / span > Since Cap'n Hugo < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.132.0< / span > < / span > < a href = "https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts" rel = "external" target = "_self" > GitHub alerts< / a > be also supported. Please note, that color'n an' ay'cons o' severities may defer between GitHub an' this theme.< / p >
< p > If ye be 'n need o' more advanced opt'ns t' style yer alerts, like ay'cons, use th' < a href = "/hugo-theme-relearn/pir/shortcodes/notice/index.html" > notice shortcode< / a > .< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!CAUTION]
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > > < / span > < span class = "ge" > Advises about risks or negative outcomes o' certain act'ns.
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!IMPORTANT]
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > > < / span > < span class = "ge" > Key informat'n users need t' know t' achieve their goal.
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!INFO]
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > > < / span > < span class = "ge" > Informat'n that users < ins> _might_< /ins> find interest'n.
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!NOTE]
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > > < / span > < span class = "ge" > Useful informat'n that users should know, even when skimm'n rrrambl'n.
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!TIP]
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > > < / span > < span class = "ge" > Helpful advice fer do'n th'ns better or more easily.
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!WARNING]
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > > Urgent info that needs immediate user attent'n t' avoid problems.< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< div class = "box notices cstyle caution" >
< div class = "box-label" >
< i class = "fa-fw fas fa-hand" > < / i > Caut'n
< / div >
< div class = "box-content" >
< p > Advises about risks or negative outcomes o' certain act'ns.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box notices cstyle important" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-bolt" > < / i > Important
2024-09-01 11:58:33 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > Key informat'n users need t' know t' achieve their goal.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box notices cstyle info" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-info-circle" > < / i > Ahoi
2024-09-01 11:58:33 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > Informat'n that users < ins > < em > might< / em > < / ins > find interest'n.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box notices cstyle note" >
< div class = "box-label" >
< i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast
< / div >
< div class = "box-content" >
< p > Useful informat'n that users should know, even when skimm'n rrrambl'n.< / p >
< / div >
< / div >
< div class = "box notices cstyle tip" >
< div class = "box-label" >
< i class = "fa-fw fas fa-lightbulb" > < / i > Smarrrt Arrrse
< / div >
< div class = "box-content" >
< p > Helpful advice fer do'n th'ns better or more easily.< / p >
< / div >
< / div >
< div class = "box notices cstyle warning" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-exclamation-triangle" > < / i > Arrr
2024-09-01 11:58:33 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > Urgent info that needs immediate user attent'n t' avoid problems.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< / div >
< h3 id = "obsidian-callouts" > Obsidian Callouts< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw far fa-gem" > < / i > < / span > < span class = "badge-content" style = "background-color: #7c3aed;" > Obsidian< / span > < / span > Since Cap'n Hugo < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.134.0< / span > < / span > < a href = "https://help.obsidian.md/Editing+and+formatting/Callouts#Change+the+title" rel = "external" target = "_self" > Obsidian callouts< / a > be also supported. Which enables configur'ble title text an' expand/collapse.< / p >
< p > If ye be 'n need o' more advanced opt'ns t' style yer alerts, like ay'cons, use th' < a href = "/hugo-theme-relearn/pir/shortcodes/notice/index.html" > notice shortcode< / a > .< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!tip] Callouts can have custom titles
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > > < / span > < span class = "ge" > Like this one.
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!tip] Title-only callout
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!note]- Be callouts fold'ble?
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > > < / span > < span class = "ge" > Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > [!note]+ Be callouts fold'ble?
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > > Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< div class = "box notices cstyle tip" >
< div class = "box-label" >
< i class = "fa-fw fas fa-lightbulb" > < / i > Callouts can have custom titles
< / div >
< div class = "box-content" >
< p > Like this one.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box notices cstyle tip" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-lightbulb" > < / i > Title-only callout
2024-09-01 11:58:33 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< div class = "expand box notices cstyle note" >
2024-10-15 10:39:20 +00:00
< input type = "checkbox" id = "R-expand-62124a595e105ffe756a5949b4b20c86" aria-controls = "R-expandcontent-62124a595e105ffe756a5949b4b20c86" >
< label class = "expand-label box-label" for = "R-expand-62124a595e105ffe756a5949b4b20c86" >
2024-10-13 14:26:50 +00:00
< i class = "expander-icon fa-fw fas fa-chevron-down" > < / i >
< i class = "expander-icon fa-fw fas fa-chevron-right" > < / i > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Be callouts fold'ble?
< / label >
< div class = "box-spacer" > < / div >
2024-10-15 10:39:20 +00:00
< div id = "R-expandcontent-62124a595e105ffe756a5949b4b20c86" class = "box-content expand-content" >
2024-10-13 14:26:50 +00:00
< p > Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "expand box notices cstyle note" >
2024-10-15 10:39:20 +00:00
< input type = "checkbox" id = "R-expand-85bffe694715a186b989d125db6b9701" aria-controls = "R-expandcontent-85bffe694715a186b989d125db6b9701" checked >
< label class = "expand-label box-label" for = "R-expand-85bffe694715a186b989d125db6b9701" >
2024-10-13 14:26:50 +00:00
< i class = "expander-icon fa-fw fas fa-chevron-down" > < / i >
< i class = "expander-icon fa-fw fas fa-chevron-right" > < / i > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Be callouts fold'ble?
< / label >
< div class = "box-spacer" > < / div >
2024-10-15 10:39:20 +00:00
< div id = "R-expandcontent-85bffe694715a186b989d125db6b9701" class = "box-content expand-content" >
2024-10-13 14:26:50 +00:00
< p > Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed< / p >
< / div >
< / div >
< / div >
< / div >
< h2 id = "text-markers" > Text Markers< / h2 >
< h3 id = "bold" > Bold< / h3 >
< p > Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks < code > **< / code > .< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > I am rendered wit' **bold text**< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > I am rendered wit' < strong > bold text< / strong > < / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "italics" > Italics< / h3 >
< p > Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores < code > _< / code > .< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > I am rendered wit' _italicized text_< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > I am rendered wit' < em > italicized text< / em > < / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "marked-text" > Marked Text< / h3 >
< p > Ye can mark text 'n th' predefined accent color o' yer stylesheet.< / p >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > Cap'n Hugo< / span > < / span > Since Cap'n Hugo 0.126.0, ye can < a href = "https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel = "external" target = "_self" > activate this through th' < em > Cap'n Hugo Extra Extension< / em > < / a > 'n yer < code > hugo.toml< / code > < / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ==Parts== o' this text ==are marked!==< / span > < / span > < / code > < / pre > < / div >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-code" > < / i > < / span > < span class = "badge-content" style = "background-color: orangered;" > HTML< / span > < / span > Ye can also use it by configur'n Hugo fer < a href = "https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel = "external" target = "_self" > usage o' HTML< / a > .< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-html" data-lang = "html" > < span class = "line" > < span class = "cl" > < span class = "p" > < < / span > < span class = "nt" > mark< / span > < span class = "p" > > < / span > Parts< span class = "p" > < /< / span > < span class = "nt" > mark< / span > < span class = "p" > > < / span > o' this text < span class = "p" > < < / span > < span class = "nt" > mark< / span > < span class = "p" > > < / span > be marked!< span class = "p" > < /< / span > < span class = "nt" > mark< / span > < span class = "p" > > < / span > < / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > < mark > Parts< / mark > o' this text < mark > be marked!< / mark > < / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-10-08 19:39:32 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "inserted-text" > Inserted Text< / h3 >
< p > Ye can mark text addit'ns t' exist'n text.< / p >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > Cap'n Hugo< / span > < / span > Since Cap'n Hugo 0.126.0, ye can < a href = "https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel = "external" target = "_self" > activate this through th' < em > Cap'n Hugo Extra Extension< / em > < / a > 'n yer < code > hugo.toml< / code > < / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > Th' ++hot, new++ stuff< / span > < / span > < / code > < / pre > < / div >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-code" > < / i > < / span > < span class = "badge-content" style = "background-color: orangered;" > HTML< / span > < / span > Ye can also use it by configur'n Hugo fer < a href = "https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel = "external" target = "_self" > usage o' HTML< / a > .< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-html" data-lang = "html" > < span class = "line" > < span class = "cl" > Th' < span class = "p" > < < / span > < span class = "nt" > ins< / span > < span class = "p" > > < / span > hot, new< span class = "p" > < /< / span > < span class = "nt" > ins< / span > < span class = "p" > > < / span > stuff< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > Th' < ins > hot, new< / ins > stuff< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "deleted-text" > Deleted Text< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-github" > < / i > < / span > < span class = "badge-content" style = "background-color: darkgray;" > GFM< / span > < / span > Ye can do strikethroughs by enclos'n text wit' two tildes < code > ~~< / code > . See < a href = "https://gohugo.io/getting-started/configuration-markup/#extras" rel = "external" target = "_self" > Hugo’ s documentat'n remarks< / a > if ye want t' use this together wit' th' subscript rules.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ~~Strike through~~ this text< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > < del > Strike through< / del > this text< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "special-typesetting" > Special Typesett'n< / h2 >
< h3 id = "text-substitution" > Text Substitut'n< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-lightbulb" > < / i > < / span > < span class = "badge-content" style = "background-color: darkorange;" > Pants< / span > < / span > Ye can combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > Do'ble quotes < span class = "sb" > `" `< / span > an' single quotes < span class = "sb" > `' `< / span > o' enclosed text be replaced by < span class = "ge" > **< / span > " do'ble curly quotes" ** an' < span class = "ge" > **< / span > ' single curly quotes' **.
2022-10-08 19:39:32 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Do'ble dashes < span class = "sb" > `--`< / span > an' triple dashes < span class = "sb" > `---`< / span > be replaced by en-dash < span class = "ge" > **< / span > --** an' em-dash < span class = "ge" > **< / span > ---** entities.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Do'ble arrows point'n left < span class = "sb" > `< < `< / span > or right < span class = "sb" > `> > `< / span > be replaced by arrow < span class = "ge" > **< / span > < span class = "err" > < < < / span > ** an' < span class = "ge" > **< / span > > > ** entities.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Three consecutive dots < span class = "sb" > `...`< / span > be replaced by an ellipsis < span class = "ge" > **< / span > ...** entity.< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > Do'ble quotes < code > " < / code > an' single quotes < code > '< / code > o' enclosed text be replaced by < strong > “ do'ble curly quotes” < / strong > an' < strong > ‘ single curly quotes’ < / strong > .< / p >
< p > Do'ble dashes < code > --< / code > an' triple dashes < code > ---< / code > be replaced by en-dash < strong > – < / strong > an' em-dash < strong > — < / strong > entities.< / p >
< p > Do'ble arrows point'n left < code > < < < / code > or right < code > > > < / code > be replaced by arrow < strong > « < / strong > an' < strong > » < / strong > entities.< / p >
< p > Three consecutive dots < code > ...< / code > be replaced by an ellipsis < strong > … < / strong > entity.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "subscript-and-superscript" > Subscript an' Superscript< / h3 >
< p > Ye can also use subscript an' superscript text. For more complex stuff, ye can use th' < a href = "/hugo-theme-relearn/pir/shortcodes/math/index.html" > < code > math< / code > shortcode< / a > .< / p >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > Cap'n Hugo< / span > < / span > Since Cap'n Hugo 0.126.0, ye can < a href = "https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel = "external" target = "_self" > activate this through th' < em > Cap'n Hugo Extra Extension< / em > < / a > 'n yer < code > hugo.toml< / code > < / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > How many liters H~2~O fit into 1dm^3^?< / span > < / span > < / code > < / pre > < / div >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-code" > < / i > < / span > < span class = "badge-content" style = "background-color: orangered;" > HTML< / span > < / span > Ye can also use it by configur'n Hugo fer < a href = "https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel = "external" target = "_self" > usage o' HTML< / a > .< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-html" data-lang = "html" > < span class = "line" > < span class = "cl" > How many liters H< span class = "p" > < < / span > < span class = "nt" > sub< / span > < span class = "p" > > < / span > 2< span class = "p" > < /< / span > < span class = "nt" > sub< / span > < span class = "p" > > < / span > O fit into 1dm< span class = "p" > < < / span > < span class = "nt" > sup< / span > < span class = "p" > > < / span > 3< span class = "p" > < /< / span > < span class = "nt" > sup< / span > < span class = "p" > > < / span > ?< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > How many liters H< sub > 2< / sub > O fit into 1dm< sup > 3< / sup > ?< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "keyboard-shortcuts" > Keyboard Shortcuts< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-code" > < / i > < / span > < span class = "badge-content" style = "background-color: orangered;" > HTML< / span > < / span > Ye can use th' < code > < kbd> < / code > element t' style keyboard shortcuts.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-html" data-lang = "html" > < span class = "line" > < span class = "cl" > Press < span class = "p" > < < / span > < span class = "nt" > kbd< / span > < span class = "p" > > < / span > STRG< span class = "p" > < /< / span > < span class = "nt" > kbd< / span > < span class = "p" > > < / span > < span class = "p" > < < / span > < span class = "nt" > kbd< / span > < span class = "p" > > < / span > ALT< span class = "p" > < /< / span > < span class = "nt" > kbd< / span > < span class = "p" > > < / span > < span class = "p" > < < / span > < span class = "nt" > kbd< / span > < span class = "p" > > < / span > DEL< span class = "p" > < /< / span > < span class = "nt" > kbd< / span > < span class = "p" > > < / span > t' end yer shift early.< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > Press < kbd > STRG< / kbd > < kbd > ALT< / kbd > < kbd > DEL< / kbd > t' end yer shift early.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "lists" > Lists< / h2 >
< h3 id = "unordered" > Unordered< / h3 >
< p > Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.< / p >
< p > It be poss'ble t' nest lists by indent'n an item fer th' next sublevel.< / p >
< p > Ye may use any o' < code > -< / code > , < code > *< / code > or < code > +< / code > t' denote bullets fer each list item but should not switch between those symbols inside one whole list.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Lorem ipsum dolor sit amet
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Consectetur adipisc'n elit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Vestibulum laoreet porttitor sem
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Ac tristique libero volutpat at
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Nulla volutpat aliquam velit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Phasellus iaculis neque
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Purus sodales ultricies
< / span > < / span > < span class = "line" > < span class = "cl" > - Faucibus porta lacus fringilla vel< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< ul >
< li > Lorem ipsum dolor sit amet< / li >
< li > Consectetur adipisc'n elit
< ul >
< li > Vestibulum laoreet porttitor sem< / li >
< li > Ac tristique libero volutpat at< / li >
< / ul >
< / li >
< li > Nulla volutpat aliquam velit
< ul >
< li > Phasellus iaculis neque< / li >
< li > Purus sodales ultricies< / li >
< / ul >
< / li >
< li > Faucibus porta lacus fringilla vel< / li >
< / ul >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "ordered" > Ordered< / h3 >
< p > Ye can create a list o' items 'n which th' order o' items does explicitly matter.< / p >
< p > It be poss'ble t' nest lists by indent'n an item fer th' next sublevel.< / p >
< p > Marrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Lorem ipsum dolor sit amet
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 3.< / span > Consectetur adipisc'n elit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Integer molestie lorem at massa
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 7.< / span > Facilisis 'n pretium nisl aliquet
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 99.< / span > Nulla volutpat aliquam velit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Faucibus porta lacus fringilla vel
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Aenean sit amet erat nunc
< / span > < / span > < span class = "line" > < span class = "cl" > 17. Eget porttitor lorem< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< ol >
< li > Lorem ipsum dolor sit amet< / li >
< li > Consectetur adipisc'n elit
< ol >
< li > Integer molestie lorem at massa< / li >
< li > Facilisis 'n pretium nisl aliquet< / li >
< / ol >
< / li >
< li > Nulla volutpat aliquam velit
< ol >
< li > Faucibus porta lacus fringilla vel< / li >
< li > Aenean sit amet erat nunc< / li >
< / ol >
< / li >
< li > Eget porttitor lorem< / li >
< / ol >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "tasks" > Tasks< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-github" > < / i > < / span > < span class = "badge-content" style = "background-color: darkgray;" > GFM< / span > < / span > Ye can add task lists result'n 'n checked or unchecked non-click'ble items< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > < span class = "k" > - [x]< / span > Basic Test
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [ ]< / span > More Tests
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [x]< / span > View
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [x]< / span > Hear
< / span > < / span > < span class = "line" > < span class = "cl" > - [ ] Smell< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< ul >
< li > < input checked = "" disabled = "" type = "checkbox" > Basic Test< / li >
< li > < input disabled = "" type = "checkbox" > More Tests
< ul >
< li > < input checked = "" disabled = "" type = "checkbox" > View< / li >
< li > < input checked = "" disabled = "" type = "checkbox" > Hear< / li >
< li > < input disabled = "" type = "checkbox" > Smell< / li >
< / ul >
< / li >
< / ul >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "definitions" > Definit'ns< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-php" > < / i > < / span > < span class = "badge-content" style = "background-color: #888cc4;" > PHP< / span > < / span > Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.< / p >
< p > A definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.< / p >
< p > If ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > Apple
< / span > < / span > < span class = "line" > < span class = "cl" > : Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae.
< / span > < / span > < span class = "line" > < span class = "cl" > : An American computer company.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Orange
< / span > < / span > < span class = "line" > < span class = "cl" > : Th' fruit o' an evergreen tree o' th' genus Citrus.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Ye can make juice out o' it.
< / span > < / span > < span class = "line" > < span class = "cl" > : A telecommunicat'n company.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Ye can' t make juice out o' it.< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< dl >
< dt > Apple< / dt >
< dd > Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae.< / dd >
< dd > An American computer company.< / dd >
< dt > Orange< / dt >
< dd > Th' fruit o' an evergreen tree o' th' genus Citrus.
< p > Ye can make juice out o' it.< / p >
< / dd >
< dd > A telecommunicat'n company.
< p > Ye can’ t make juice out o' it.< / p >
< / dd >
< / dl >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "code" > Code< / h2 >
< h3 id = "inline-code" > Inline Code< / h3 >
< p > Inline snippets o' code can be wrapped wit' backticks < code > `< / code > .< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > In this example, < span class = "sb" > `< div> < /div> `< / span > be marked as code.< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > In this example, < code > < div> < /div> < / code > be marked as code.< / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "indented-code-block" > Indented Code Block< / h3 >
< p > A simple code block can be generated by indent'n several lines o' code by at least two spaces.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > Be impressed by my advanced code:
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > // Some comments
< / span > < / span > < span class = "line" > < span class = "cl" > line 1 o' code
< / span > < / span > < span class = "line" > < span class = "cl" > line 2 o' code
< / span > < / span > < span class = "line" > < span class = "cl" > line 3 o' code< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > Be impressed by my advanced code:< / p >
< pre > < code > // Some comments
line 1 o' code
line 2 o' code
line 3 o' code
< / code > < / pre >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "fenced-code-block" > Fenced Code Block< / h3 >
< p > If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks < code > ```< / code > a so called fence.< / p >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-github" > < / i > < / span > < span class = "badge-content" style = "background-color: darkgray;" > GFM< / span > < / span > Ye can also add a language specifier directly after th' open'n fence, < code > ```js< / code > , an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.< / p >
< p > See < a href = "/hugo-theme-relearn/pir/shortcodes/highlight/index.html" > Code Highlight'n< / a > fer additional documentat'n.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ```js
< / span > < / span > < span class = "line" > < span class = "cl" > {
< / span > < / span > < span class = "line" > < span class = "cl" > name: " Claus" ,
< / span > < / span > < span class = "line" > < span class = "cl" > surname: " Santa" ,
< / span > < / span > < span class = "line" > < span class = "cl" > profession: " courier" ,
< / span > < / span > < span class = "line" > < span class = "cl" > age: 666,
< / span > < / span > < span class = "line" > < span class = "cl" > address: {
< / span > < / span > < span class = "line" > < span class = "cl" > city: " North Pole" ,
< / span > < / span > < span class = "line" > < span class = "cl" > postalCode: 1,
< / span > < / span > < span class = "line" > < span class = "cl" > country: " Arctic"
< / span > < / span > < span class = "line" > < span class = "cl" > },
< / span > < / span > < span class = "line" > < span class = "cl" > friends: [ " Dasher" , " Dancer" , " Prancer" , " Vixen" , " Comet" , " Cupid" , " Donder" , " Blitzen" , " Rudolph" ]
< / span > < / span > < span class = "line" > < span class = "cl" > };
< / span > < / span > < span class = "line" > < span class = "cl" > ```< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-js" data-lang = "js" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "o" > :< / span > < span class = "s2" > " Claus" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > surname< / span > < span class = "o" > :< / span > < span class = "s2" > " Santa" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > profession< / span > < span class = "o" > :< / span > < span class = "s2" > " courier" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > age< / span > < span class = "o" > :< / span > < span class = "mi" > 666< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > address< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > city< / span > < span class = "o" > :< / span > < span class = "s2" > " North Pole" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > postalCode< / span > < span class = "o" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > country< / span > < span class = "o" > :< / span > < span class = "s2" > " Arctic" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > friends< / span > < span class = "o" > :< / span > < span class = "p" > [< / span > < span class = "s2" > " Dasher" < / span > < span class = "p" > ,< / span > < span class = "s2" > " Dancer" < / span > < span class = "p" > ,< / span > < span class = "s2" > " Prancer" < / span > < span class = "p" > ,< / span > < span class = "s2" > " Vixen" < / span > < span class = "p" > ,< / span > < span class = "s2" > " Comet" < / span > < span class = "p" > ,< / span > < span class = "s2" > " Cupid" < / span > < span class = "p" > ,< / span > < span class = "s2" > " Donder" < / span > < span class = "p" > ,< / span > < span class = "s2" > " Blitzen" < / span > < span class = "p" > ,< / span > < span class = "s2" > " Rudolph" < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > };< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "tables" > Tables< / h2 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-github" > < / i > < / span > < span class = "badge-content" style = "background-color: darkgray;" > GFM< / span > < / span > Ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > | Opt'n | Descript'n |
< / span > < / span > < span class = "line" > < span class = "cl" > |--------|-------------|
< / span > < / span > < span class = "line" > < span class = "cl" > | data | path t' data files t' supply th' data that will be passed into templates. |
< / span > < / span > < span class = "line" > < span class = "cl" > | engine | engine t' be used fer process'n templates. Handlebars be th' default. |
< / span > < / span > < span class = "line" > < span class = "cl" > | ext | extension t' be used fer dest files. |< / span > < / span > < / code > < / pre > < / div >
2024-08-13 11:44:38 +00:00
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
2022-12-02 15:05:54 +00:00
< div class = "box-content" >
2024-03-16 09:01:12 +00:00
< table >
2024-09-03 17:09:09 +00:00
< thead >
< tr >
2024-10-13 14:26:50 +00:00
< th style = "text-align: left" > Opt'n< / th >
2024-09-03 17:09:09 +00:00
< th style = "text-align: left" > Descript'n< / th >
< / tr >
< / thead >
< tbody >
< tr >
2024-10-13 14:26:50 +00:00
< td style = "text-align: left" > data< / td >
< td style = "text-align: left" > path t' data files t' supply th' data that will be passed into templates.< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-13 14:26:50 +00:00
< td style = "text-align: left" > engine< / td >
< td style = "text-align: left" > engine t' be used fer process'n templates. Handlebars be th' default.< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< tr >
2024-10-13 14:26:50 +00:00
< td style = "text-align: left" > ext< / td >
< td style = "text-align: left" > extension t' be used fer dest files.< / td >
2024-09-03 17:09:09 +00:00
< / tr >
< / tbody >
2024-03-16 09:01:12 +00:00
< / table >
2023-08-25 17:35:54 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "aligned-columns" > Aligned Columns< / h3 >
< p > Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > | Opt'n | Number | Descript'n |
< / span > < / span > < span class = "line" > < span class = "cl" > |-------:|:------:|:------------|
< / span > < / span > < span class = "line" > < span class = "cl" > | data | 1 | path t' data files t' supply th' data that will be passed into templates. |
< / span > < / span > < span class = "line" > < span class = "cl" > | engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. |
< / span > < / span > < span class = "line" > < span class = "cl" > | ext | 3 | extension t' be used fer dest files. |< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2023-08-25 17:35:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
< table >
< thead >
< tr >
< th style = "text-align: right" > Opt'n< / th >
< th style = "text-align: center" > Number< / th >
< th style = "text-align: left" > Descript'n< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align: right" > data< / td >
< td style = "text-align: center" > 1< / td >
< td style = "text-align: left" > path t' data files t' supply th' data that will be passed into templates.< / td >
< / tr >
< tr >
< td style = "text-align: right" > engine< / td >
< td style = "text-align: center" > 2< / td >
< td style = "text-align: left" > engine t' be used fer process'n templates. Handlebars be th' default.< / td >
< / tr >
< tr >
< td style = "text-align: right" > ext< / td >
< td style = "text-align: center" > 3< / td >
< td style = "text-align: left" > extension t' be used fer dest files.< / td >
< / tr >
< / tbody >
< / table >
2023-08-25 17:35:54 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h2 id = "links" > Links< / h2 >
< h3 id = "autolink" > Autolink< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-github" > < / i > < / span > < span class = "badge-content" style = "background-color: darkgray;" > GFM< / span > < / span > Absolute URLs will automatically be converted into a link.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > This be a link t' https://example.com.< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2023-08-25 17:35:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
< p > This be a link t' < a href = "https://example.com" rel = "external" target = "_self" > https://example.com< / a > .< / p >
2023-08-25 17:35:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< h3 id = "basic-link" > Basic Link< / h3 >
< p > Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > [< span class = "nt" > Assemble< / span > ](< span class = "na" > http://assemble.io< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2023-08-25 17:35:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
< p > < a href = "http://assemble.io" rel = "external" target = "_self" > Assemble< / a > < / p >
2023-08-25 17:35:54 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "link-with-tooltip" > Link wit' Tooltip< / h3 >
< p > For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > [< span class = "nt" > Upstage< / span > ](< span class = "na" > https://github.com/upstage/ " Visit Upstage!" < / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2023-08-25 17:35:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
< p > < a href = "https://github.com/upstage/" rel = "external" target = "_self" title = "Visit Upstage!" > Upstage< / a > < / p >
2023-08-25 17:35:54 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< h3 id = "link-references" > Link References< / h3 >
< p > Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > [Example][somelinkID]
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > [somelinkID]: https://example.com " Go t' example domain" < / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-09-01 11:58:33 +00:00
< / div >
2023-08-25 17:35:54 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > < a href = "https://example.com" rel = "external" target = "_self" title = "Go t' example domain" > Example< / a > < / p >
2024-09-05 18:03:19 +00:00
< / div >
2023-05-30 16:02:37 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "footnotes" > Footnotes< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-php" > < / i > < / span > < span class = "badge-content" style = "background-color: #888cc4;" > PHP< / span > < / span > Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.< / p >
< p > Usually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.< / p >
< p > Footnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > That' s some text wit' a footnote[^1]
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > [^1]: An' that' s th' footnote.
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > That' s some more text wit' a footnote.[^someid]
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > [^someid]:
< / span > < / span > < span class = "line" > < span class = "cl" > Anyth'n o' interest goes here.
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Blue light glows blue.< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
< div class = "box-content" >
< p > That’ s some text wit' a footnote< sup id = "fnref:1" > < a href = "#fn:1" class = "footnote-ref" role = "doc-noteref" > 1< / a > < / sup > < / p >
< p > That’ s some more text wit' a footnote.< sup id = "fnref:2" > < a href = "#fn:2" class = "footnote-ref" role = "doc-noteref" > 2< / a > < / sup > < / p >
< div class = "footnotes" role = "doc-endnotes" >
< hr >
< ol >
< li id = "fn:1" >
< p > An' that’ s th' footnote.  < a href = "#fnref:1" class = "footnote-backref" role = "doc-backlink" > ↩ ︎ < / a > < / p >
< / li >
< li id = "fn:2" >
< p > Anyth'n o' interest goes here.< / p >
< p > Blue light glows blue.  < a href = "#fnref:2" class = "footnote-backref" role = "doc-backlink" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
< / div >
< / div >
< h2 id = "images" > Images< / h2 >
< h3 id = "basic-images" > Basic Images< / h3 >
< p > Images have a similar rules t' links but include a preced'n exclamat'n mark.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spock< / span > ](< span class = "na" > https://octodex.github.com/images/spocktocat.png< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-3eff398902b60f870e368763d2e78fbf" class = "lightbox-link" > < img alt = "Spock" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/spocktocat.png?width=20vw" style = " height: auto; width: 20vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-3eff398902b60f870e368763d2e78fbf" > < img alt = "Spock" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/spocktocat.png?width=20vw" > < / a > < / p >
2024-10-13 14:26:50 +00:00
< / div >
< / div >
< h3 id = "image-with-tooltip" > Image wit' Tooltip< / h3 >
< p > Like links, images can also be given a tooltip.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Picard< / span > ](< span class = "na" > https://octodex.github.com/images/jean-luc-picat.jpg " Jean Luc Picard" < / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-f71d785453a46c7cdcfd680834457864" class = "lightbox-link" > < img alt = "Picard" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" style = " height: auto; width: 20vw;" title = "Jean Luc Picard" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-f71d785453a46c7cdcfd680834457864" > < img alt = "Picard" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" title = "Jean Luc Picard" > < / a > < / p >
2024-10-13 14:26:50 +00:00
< / div >
< / div >
< h3 id = "image-references" > Image References< / h3 >
< p > Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![La Forge][laforge]
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > [laforge]: https://octodex.github.com/images/trekkie.jpg " Geordi La Forge" < / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-f4e27105349ac17d06ce5e539e2d9b00" class = "lightbox-link" > < img alt = "La Forge" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/trekkie.jpg?width=20vw" style = " height: auto; width: 20vw;" title = "Geordi La Forge" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-f4e27105349ac17d06ce5e539e2d9b00" > < img alt = "La Forge" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/trekkie.jpg?width=20vw" title = "Geordi La Forge" > < / a > < / p >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h3 id = "image-effects" > Image Effects< / h3 >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-puzzle-piece" > < / i > < / span > < span class = "badge-content" style = "background-color: #7dc903;" > Relearrrn< / span > < / span > This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. See th' < a href = "/hugo-theme-relearn/pir/authoring/imageeffects/index.html" > image effects docs< / a > fer a detailed example an' how t' configure it.< / p >
< h4 id = "resizing" > Resiz'n< / h4 >
< p > Add query parameter < code > width< / code > and/or < code > height< / code > t' th' link image t' resize th' image. Values be CSS values (default be < code > auto< / code > ).< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?width=20vw< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-19f77edd3a25281cd8305e7c1ead0e4d" class = "lightbox-link" > < img alt = "Minion" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/minion.png?width=20vw" style = " height: auto; width: 20vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-19f77edd3a25281cd8305e7c1ead0e4d" > < img alt = "Minion" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/minion.png?width=20vw" > < / a > < / p >
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< / div >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?height=50px< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-24cdf35b8d89bf93e91e99731abba7dd" class = "lightbox-link" > < img alt = "Minion" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/minion.png?height=50px" style = " height: 50px; width: auto;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-24cdf35b8d89bf93e91e99731abba7dd" > < img alt = "Minion" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/minion.png?height=50px" > < / a > < / p >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?height=50px& width=40vw< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-bb1b73f2ee1905c969367a2c4ea40ed2" class = "lightbox-link" > < img alt = "Minion" class = "bg-white border lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/minion.png?height=50px&width=40vw" style = " height: 50px; width: 40vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-bb1b73f2ee1905c969367a2c4ea40ed2" > < img alt = "Minion" class = "bg-white border lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/minion.png?height=50px&width=40vw" > < / a > < / p >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h4 id = "css-classes" > CSS Classes< / h4 >
< p > Add a query parameter < code > classes< / code > t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.< / p >
< h5 id = "shadow" > Shadow< / h5 >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spidertocat< / span > ](< span class = "na" > https://octodex.github.com/images/spidertocat.png?classes=shadow< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-9314b5e910378316292a057490d3859d" class = "lightbox-link" > < img alt = "Spidertocat" class = "bg-white border lazy lightbox noborder shadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" style = " height: auto; width: 20vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-9314b5e910378316292a057490d3859d" > < img alt = "Spidertocat" class = "bg-white border lazy lightbox noborder shadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" > < / a > < / p >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h5 id = "border" > Border< / h5 >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > DrOctocat< / span > ](< span class = "na" > https://octodex.github.com/images/droctocat.png?classes=border< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-66632a66a1e7b360d1c2728a49ee56f5" class = "lightbox-link" > < img alt = "DrOctocat" class = "bg-white border lazy lightbox noshadow noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" style = " height: auto; width: 20vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-66632a66a1e7b360d1c2728a49ee56f5" > < img alt = "DrOctocat" class = "bg-white border lazy lightbox noshadow noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" > < / a > < / p >
2024-10-13 14:26:50 +00:00
< / div >
< / div >
< h5 id = "left" > Left< / h5 >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Supertocat< / span > ](< span class = "na" > https://octodex.github.com/images/okal-eltocat.jpg?classes=left< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
< / div >
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-51f19624accf5f3ed38875a0c8170ec3" class = "lightbox-link" > < img alt = "Supertocat" class = "bg-white border lazy left lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" style = " height: auto; width: 20vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-51f19624accf5f3ed38875a0c8170ec3" > < img alt = "Supertocat" class = "bg-white border lazy left lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" > < / a > < / p >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h5 id = "right" > Right< / h5 >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Riddlocat< / span > ](< span class = "na" > https://octodex.github.com/images/riddlocat.jpg?classes=right< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-09-01 11:58:33 +00:00
< / div >
2023-01-25 11:42:06 +00:00
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-9ff3e4631ddf671002c091387f7a450d" class = "lightbox-link" > < img alt = "Riddlocat" class = "bg-white border lazy lightbox right noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" style = " height: auto; width: 20vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-9ff3e4631ddf671002c091387f7a450d" > < img alt = "Riddlocat" class = "bg-white border lazy lightbox right noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" > < / a > < / p >
2024-09-05 18:03:19 +00:00
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h5 id = "inline" > Inline< / h5 >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spidertocat< / span > ](< span class = "na" > https://octodex.github.com/images/spidertocat.png?classes=inline< / span > )
< / span > < / span > < span class = "line" > < span class = "cl" > ![< span class = "nt" > DrOctocat< / span > ](< span class = "na" > https://octodex.github.com/images/droctocat.png?classes=inline< / span > )
< / span > < / span > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Supertocat< / span > ](< span class = "na" > https://octodex.github.com/images/okal-eltocat.jpg?classes=inline< / span > )
< / span > < / span > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Riddlocat< / span > ](< span class = "na" > https://octodex.github.com/images/riddlocat.jpg?classes=inline< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
< div class = "box-label" >
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-03-02 10:05:50 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-16eb0fc34aba4ab85cf8a5c005861997" class = "lightbox-link" > < img alt = "Spidertocat" class = "bg-white border inline lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" style = " height: auto; width: 10vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-16eb0fc34aba4ab85cf8a5c005861997" > < img alt = "Spidertocat" class = "bg-white border inline lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" > < / a >
< a href = "#R-image-c4fab51d473b55b455a74c089d7a29cd" class = "lightbox-link" > < img alt = "DrOctocat" class = "bg-white border inline lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" style = " height: auto; width: 10vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-c4fab51d473b55b455a74c089d7a29cd" > < img alt = "DrOctocat" class = "bg-white border inline lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" > < / a >
< a href = "#R-image-9ba71684b42bef5e65a5ed34c036acce" class = "lightbox-link" > < img alt = "Supertocat" class = "bg-white border inline lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" style = " height: auto; width: 10vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-9ba71684b42bef5e65a5ed34c036acce" > < img alt = "Supertocat" class = "bg-white border inline lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" > < / a >
< a href = "#R-image-0c92b5ccf726d1951480dbec5363f747" class = "lightbox-link" > < img alt = "Riddlocat" class = "bg-white border inline lazy lightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" style = " height: auto; width: 10vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-0c92b5ccf726d1951480dbec5363f747" > < img alt = "Riddlocat" class = "bg-white border inline lazy lightbox noshadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" > < / a > < / p >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< h5 id = "combination" > Combinat'n< / h5 >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > X-tocat< / span > ](< span class = "na" > https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-09-01 11:58:33 +00:00
< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2024-10-15 10:39:20 +00:00
< p > < a href = "#R-image-3a9c6e982d2490352be425eddb525968" class = "lightbox-link" > < img alt = "X-tocat" class = "bg-white border lazy left lightbox shadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" style = " height: auto; width: 20vw;" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-3a9c6e982d2490352be425eddb525968" > < img alt = "X-tocat" class = "bg-white border lazy left lightbox shadow lightbox-image" loading = "lazy" src = "https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" > < / a > < / p >
2024-09-05 18:03:19 +00:00
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< h4 id = "lightbox" > Lightbox< / h4 >
< p > Add th' query parameter < code > lightbox=false< / code > t' th' image link t' dis'ble th' lightbox.< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Homercat< / span > ](< span class = "na" > https://octodex.github.com/images/homercat.png?lightbox=false< / span > )< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle code" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-eye" > < / i > Result
2024-09-01 11:58:33 +00:00
< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > < img alt = "Homercat" class = "bg-white border lazy nolightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" style = " height: auto; width: 20vw;" > < / p >
2024-09-05 18:03:19 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< div class = "box notices cstyle note" >
2024-09-01 11:58:33 +00:00
< div class = "box-label" >
2024-10-13 14:26:50 +00:00
< i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast
2024-09-01 11:58:33 +00:00
< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2024-10-13 14:26:50 +00:00
< p > If ye want t' wrap an image 'n a link an' < code > lightbox=true< / code > be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:< / p >
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > [< span class = "nt" > ![Homercat< / span > ](< span class = "na" > https://octodex.github.com/images/homercat.png?lightbox=false< / span > )](https://octodex.github.com/#homercat)< / span > < / span > < / code > < / pre > < / div >
< p > < a href = "https://octodex.github.com/#homercat" rel = "external" target = "_self" > < img alt = "Homercat" class = "bg-white border lazy nolightbox noshadow figure-image" loading = "lazy" src = "https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" style = " height: auto; width: 20vw;" > < / a > < / p >
2024-09-05 18:03:19 +00:00
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
< i class = "fa-fw fas fa-layer-group" > < / i >
< ul >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/howto/index.html" > Howto< / a > < / li >
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/reference/index.html" > Reference< / a > < / li >
< / ul >
< / div >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "image-effects" > Image Effects< / h1 >
< p > Th' theme offers < a href = "/hugo-theme-relearn/pir/authoring/markdown/index.html#image-effects" > graphical effects< / a > fer yer linked images.< / p >
< p > Ye can < a href = "/hugo-theme-relearn/pir/configuration/customization/imageeffects/index.html" > define additional custom image effects an' set defaults< / a > 'n yer configurat'n.< / p >
< p > Th' default image effects shipped wit' th' theme be< / p >
< table >
< thead >
< tr >
< th style = "text-align: left" > Name< / th >
< th style = "text-align: left" > Descript'n< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align: left" > border< / td >
< td style = "text-align: left" > Draws a light thin border around th' image< / td >
< / tr >
< tr >
< td style = "text-align: left" > lazy< / td >
< td style = "text-align: left" > Lets th' image be lazy boarded< / td >
< / tr >
< tr >
< td style = "text-align: left" > lightbox< / td >
< td style = "text-align: left" > Th' image will be click'ble t' show it enlarged< / td >
< / tr >
< tr >
< td style = "text-align: left" > shadow< / td >
< td style = "text-align: left" > Draws a shadow around th' image t' make it appear hovered/glow'n< / td >
< / tr >
< / tbody >
< / table >
< p > One way t' use them be t' add them as URL query parameter t' each individually linked image.< / p >
< p > This can become cumbersome t' be done consistently fer th' whole ship. Instead, ye can < a href = "/hugo-theme-relearn/pir/configuration/customization/imageeffects/index.html" > configure th' defaults< / a > 'n yer < code > hugo.toml< / code > as well as overrid'n these defaults 'n a page’ s front matter.< / p >
< p > Explicitly set URL query parameter will override th' defaults set fer a plank or yer ship.< / p >
< p > Without any sett'ns 'n yer < code > hugo.toml< / code > < code > imageEffects< / code > defaults t'< / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
2024-10-13 14:26:50 +00:00
< div class = "tab-nav-title" > ​ < / div >
2024-03-02 10:05:50 +00:00
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < 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" > imageEffects< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lazy< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lightbox< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > shadow< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > imageEffects< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > border< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > lazy< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > lightbox< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > shadow< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " imageEffects" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " border" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " lazy" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " lightbox" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " shadow" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
2024-03-02 10:05:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< p > < span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fab fa-markdown" > < / i > < / span > < span class = "badge-content" > Front Matter< / span > < / span > This can be overridden 'n a planks front matter fer example by< / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
2024-10-13 14:26:50 +00:00
< div class = "tab-nav-title" > ​ < / div >
2024-03-02 10:05:50 +00:00
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < 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 = "p" > [< / span > < span class = "nx" > imageEffects< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lazy< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nn" > ---< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > imageEffects< / span > < span class = "p" > :< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > lazy< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nn" > ---< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " imageEffects" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " lazy" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
2024-03-02 10:05:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< p > Or by explicitly override sett'ns by URL query parameter< / p >
2024-10-15 10:39:20 +00:00
< div class = "tab-panel" data-tab-group = "6201a40b659fe6e24f5f8a11c0fdc4f9" >
2024-03-02 10:05:50 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2024-10-13 14:26:50 +00:00
data-tab-item="url"
2024-03-02 10:05:50 +00:00
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
2024-10-15 10:39:20 +00:00
onclick="switchTab('6201a40b659fe6e24f5f8a11c0fdc4f9','url')"
2024-03-02 10:05:50 +00:00
>
2024-10-13 14:26:50 +00:00
< span class = "tab-nav-text" > URL< / span >
2024-03-02 10:05:50 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2024-10-13 14:26:50 +00:00
data-tab-item="url"
2024-03-02 10:05:50 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?lazy=true& lightbox=false< / span > )< / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
2024-10-13 14:26:50 +00:00
< / div > < p > Th' sett'ns applied t' th' above image would be< / p >
2024-03-02 10:05:50 +00:00
< div class = "tab-panel" data-tab-group = "config-code" >
< div class = "tab-nav" >
2024-10-13 14:26:50 +00:00
< div class = "tab-nav-title" > ​ < / div >
2024-03-02 10:05:50 +00:00
< button
data-tab-item="toml"
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
onclick="switchTab('config-code','toml')"
>
< span class = "tab-nav-text" > toml< / span >
< / button >
< button
data-tab-item="yaml"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','yaml')"
>
< span class = "tab-nav-text" > yaml< / span >
< / button >
< button
data-tab-item="json"
class="tab-nav-button tab-panel-style cstyle initial"
onclick="switchTab('config-code','json')"
>
< span class = "tab-nav-text" > json< / span >
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="toml"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lazy< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lightbox< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > shadow< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="yaml"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-10-13 14:26:50 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-yaml" data-lang = "yaml" > < span class = "line" > < span class = "cl" > < span class = "nt" > border< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > lazy< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > true< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > lightbox< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < span class = "w" >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "w" > < / span > < span class = "nt" > shadow< / span > < span class = "p" > :< / span > < span class = "w" > < / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div >
2024-09-05 18:03:19 +00:00
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< div
data-tab-item="json"
class="tab-content tab-panel-style cstyle initial">
< div class = "tab-content-text" >
2024-03-11 20:44:09 +00:00
< div class = "highlight wrap-code" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
2024-10-13 14:26:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " border" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " lazy" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " lightbox" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " shadow" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span >
2024-09-05 18:03:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span > < / span > < / span > < / code > < / pre > < / div >
< / div >
2024-03-02 10:05:50 +00:00
< / div >
< / div >
< / div >
2024-04-24 21:05:57 +00:00
2023-05-26 06:40:21 +00:00
2024-10-13 14:26:50 +00:00
< footer class = "footline" >
< div class = "R-taxonomy taxonomy-categories cstyle" title = "Categorrries" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
2023-10-05 06:14:23 +00:00
< i class = "fa-fw fas fa-layer-group" > < / i >
2023-10-03 11:21:35 +00:00
< ul >
2024-10-13 14:26:50 +00:00
< li > < a class = "term-link" href = "/hugo-theme-relearn/pir/categories/explanation/index.html" > Explanation< / a > < / li >
2023-10-03 11:21:35 +00:00
< / ul >
< / div >
2024-10-13 14:26:50 +00:00
< / footer >
< / article >
2023-05-17 22:13:41 +00:00
< / section >
< / div >
2022-04-02 13:30:16 +00:00
< / main >
< / div >
2024-10-15 10:39:20 +00:00
< script src = "/hugo-theme-relearn/js/clipboard.min.js?1728988750" defer > < / script >
< script src = "/hugo-theme-relearn/js/perfect-scrollbar.min.js?1728988750" defer > < / script >
< script src = "/hugo-theme-relearn/js/theme.js?1728988750" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
