2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2023-02-08 21:24:18 +00:00
< html lang = "pir" dir = "rtl" >
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" >
2023-01-22 21:19:30 +00:00
< meta name = "generator" content = "Hugo 0.110.0" >
2023-02-07 17:09:51 +00:00
< meta name = "generator" content = "Relearn 5.11.2+tip" >
2022-04-02 13:30:16 +00:00
< meta name = "description" content = "Documentation for Hugo Relearn Theme" >
< meta name = "author" content = "Sören Weber" >
< title > Cap' n Hugo Relearrrn Theme< / title >
2023-01-25 11:42:06 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/index.html" rel = "alternate" hreflang = "pir" >
2022-11-15 06:35:08 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/index.html" rel = "canonical" type = "text/html" title = "Cap'n Hugo Relearrrn Theme" >
2022-11-05 23:35:48 +00:00
< link href = "../pir/index.xml" rel = "alternate" type = "application/rss+xml" title = "Cap'n Hugo Relearrrn Theme" >
2023-02-10 23:05:55 +00:00
< link href = "../images/logo.svg?1676070347" rel = "icon" type = "image/svg+xml" >
2022-07-15 13:20:02 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2023-02-10 23:05:55 +00:00
< link href = "../css/fontawesome-all.min.css?1676070349" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../css/fontawesome-all.min.css?1676070349" rel = "stylesheet" > < / noscript >
< link href = "../css/nucleus.css?1676070349" rel = "stylesheet" >
< link href = "../css/auto-complete.css?1676070349" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../css/auto-complete.css?1676070349" rel = "stylesheet" > < / noscript >
< link href = "../css/perfect-scrollbar.min.css?1676070349" rel = "stylesheet" >
< link href = "../css/fonts.css?1676070349" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../css/fonts.css?1676070349" rel = "stylesheet" > < / noscript >
< link href = "../css/theme.css?1676070349" rel = "stylesheet" >
< link href = "../css/theme-auto.css?1676070349" rel = "stylesheet" id = "variant-style" >
< link href = "../css/variant.css?1676070349" rel = "stylesheet" >
< link href = "../css/print.css?1676070349" rel = "stylesheet" media = "print" >
< link href = "../css/format-print.css?1676070349" rel = "stylesheet" >
< link href = "../css/ie.css?1676070349" rel = "stylesheet" >
< script src = "../js/url.js?1676070349" > < / script >
< script src = "../js/variant.js?1676070349" > < / script >
2022-04-02 13:30:16 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
2022-11-05 23:35:48 +00:00
window.index_js_url="../pir/index.search.js";
var root_url="../";
2022-04-02 13:30:16 +00:00
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy t\u0027 clipboard';
window.T_Copied_to_clipboard = 'Copied t\u0027 clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link t\u0027 clipboard';
window.T_Link_copied_to_clipboard = 'Copied link t\u0027 clipboard!';
2022-11-17 21:13:11 +00:00
window.T_No_results_found = 'No rrresults found fer \u0022{0}\u0022';
window.T_N_results_found = '{1} rrresults found fer \u0022{0}\u0022';
2022-04-02 13:30:16 +00:00
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
2023-02-04 21:34:28 +00:00
window.variants & & variants.init( [ 'auto', 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:05:54 +00:00
< style >
#body img.bg-white {
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2022-11-15 06:35:08 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../pir/index.html" >
2022-04-02 13:30:16 +00:00
< div id = "body" class = "default-animation" >
< div id = "sidebar-overlay" > < / div >
< div id = "toc-overlay" > < / div >
2023-02-08 23:54:12 +00:00
< nav id = "topbar" class = "highlightable" >
2022-04-02 13:30:16 +00:00
< div >
< div id = "breadcrumbs" >
< span id = "sidebar-toggle-span" >
2023-02-04 15:02:34 +00:00
< a href = "#" id = "sidebar-toggle" class = "topbar-link" title = 'Menu (CTRL+ALT+n)' > < i class = "fas fa-bars fa-fw" > < / i > < / a >
2022-04-02 13:30:16 +00:00
< / span >
< ol class = "links" itemscope itemtype = "http://schema.org/BreadcrumbList" >
2022-10-02 22:25:49 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < span itemprop = "name" > Cap' n Hugo Relearrrn Theme< / span > < meta itemprop = "position" content = "1" > < / li >
2022-04-02 13:30:16 +00:00
< / ol >
< / div >
< / div >
< / nav >
2022-07-05 22:16:52 +00:00
< main id = "body-inner" class = "highlightable home" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
< div id = "head-tags" >
< / div >
2022-11-07 19:58:08 +00:00
< article class = "home" >
2022-11-13 21:34:47 +00:00
< h1 id = "capn-hugo-relearrrn-theme" > Cap' n Hugo Relearrrn Theme< / h1 >
2022-04-02 13:30:16 +00:00
2022-05-29 22:03:12 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Arrr! Pirrrates< / div >
< div class = "box-content" >
2023-02-10 16:31:44 +00:00
< p > Fello' pirrrates, grog made us dizzy! Be awarrre < b > some stuff may not work< / b > in this trrranslat'n. Like see'n < b > Merrrmaids< / b > , do'n < b > math or chemistrrry< / b > , writ'n docs and stuff.< / p >
2022-12-04 10:37:18 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-02-10 23:05:55 +00:00
< p > A theme fer < a href = "https://gohugo.io/" target = "_blank" > Cap'n Hugo< / a > designed fer documentat'n.< / p >
2023-02-10 21:17:53 +00:00
< p > < a href = "../basics/migration/" > ★ What’ s new 'n th' latest release ★< / a > < / p >
< p >
2023-02-10 23:05:55 +00:00
< a href = "#image-a626b50c736c76bc52b8183f38a5b52d" class = "lightbox-link" >
2023-02-10 21:58:51 +00:00
< img src = "../images/hero.png?classes=shadow&width=100%25&height=100%25" alt = "Image o' th' Relearrrn theme 'n light an' dark mode on phone, tablet an' desktop" class = "shadow" style = "height: auto; width: auto;" loading = "lazy" >
2023-02-10 21:17:53 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-a626b50c736c76bc52b8183f38a5b52d" >
2023-02-10 21:58:51 +00:00
< img src = "../images/hero.png?classes=shadow&width=100%25&height=100%25" alt = "Image o' th' Relearrrn theme 'n light an' dark mode on phone, tablet an' desktop" class = "lightbox-image" loading = "lazy" >
2023-02-10 21:17:53 +00:00
< / a > < / p >
< h2 id = "motivation" > Motivat'n< / h2 >
2022-12-23 11:24:54 +00:00
< p > Th' theme be a fork o' th' great < a href = "https://github.com/matcornic/hugo-theme-learn" target = "_blank" > Learrrn theme< / a > wit' th' aim o' fix'n long outstand'n bugs an' adept'n t' latest Cap'n Hugo features. As far as poss'ble this theme tries t' be a drop-in replacement fer th' Learrrn theme.< / p >
2022-12-14 21:48:05 +00:00
< h2 id = "features" > Features< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
2023-02-10 21:17:53 +00:00
< li > < strong > Wide set o' usage scenarios< / strong >
< ul >
< li > Responsive design fer mobile usage< / li >
< li > Looks nice on paper (if ye have to)< / li >
2022-04-02 13:30:16 +00:00
< li > Us'ble offline, no external dependencies< / li >
2023-02-10 21:17:53 +00:00
< li > < a href = "../basics/configuration/#serving-your-page-from-the-filesystem" > Us'ble from yer local file system via < code > file://< / code > protocol< / a > < / li >
2022-04-11 09:04:56 +00:00
< li > Support fer Internet Explorer 11< / li >
2023-02-10 21:17:53 +00:00
< / ul >
< / li >
< li > < strong > Configur'ble them'n an' visuals< / strong >
< ul >
< li > < a href = "../basics/customization/#change-the-logo" > Configur'ble brand images< / a > < / li >
< li > < a href = "../basics/customization/#adjusting-to-os-settings" > Automatic switch fer light/dark variant dependend on yer OS sett'ns< / a > < / li >
< li > Predefined light, dark an' color variants< / li >
< li > < a href = "../basics/customization/#multiple-variants" > User select'ble variants< / a > < / li >
< li > < a href = "../basics/generator/" > Stylesheet generator< / a > < / li >
< li > < a href = "../cont/syntaxhighlight/" > Configur'ble rules highlight'n< / a > < / li >
< / ul >
< / li >
< li > < strong > Unique theme features< / strong >
< ul >
< li > < a href = "../basics/configuration/#activate-print-support" > Print whole chapters or even th' complete ship< / a > < / li >
< li > In plank search< / li >
< li > < a href = "../basics/configuration/#activate-search" > Ship search< / a > < / li >
2022-12-16 17:42:17 +00:00
< li > < a href = "../basics/configuration/#activate-dedicated-search-page" > Dedicated search plank< / a > < / li >
< li > < a href = "../cont/tags/" > Tagg'n support< / a > < / li >
2023-02-10 21:17:53 +00:00
< li > Hidden planks< / li >
< li > Unlimited nested menu dependend on yer ship structure< / li >
< li > Navigat'n buttons dependend on yer ship structure< / li >
< li > < a href = "../cont/menushortcuts/" > Configur'ble shortcut links< / a > < / li >
< / ul >
< / li >
< li > < strong > Multi language support< / strong >
< ul >
< li > < a href = "../cont/i18n/" > Full support fer languages written right t' left< / a > < / li >
2023-02-10 21:58:51 +00:00
< li > < a href = "../cont/i18n/#basic-configuration" > Avail'ble languages< / a > : Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese< / li >
2023-02-10 21:17:53 +00:00
< li > < a href = "../cont/i18n/#search" > Search support fer mixed language rrrambl'n< / a > < / li >
< / ul >
< / li >
< li > < strong > Additional Marrrkdown features< / strong >
< ul >
< li > < a href = "../cont/markdown/" > Support fer GFM (GitHub Flavored Marrrkdown< / a > < / li >
< li > < a href = "../cont/markdown/#further-image-formatting" > Image styl'n like siz'n, shadow, border an' alignment< / a > < / li >
< li > < a href = "../cont/markdown/#further-image-formatting#lightbox" > Image lightbox< / a > < / li >
< / ul >
< / li >
< li > < strong > Shorrrtcodes galore< / strong >
< ul >
< li > < a href = "../shortcodes/attachments/" > Display files attached t' plank bundles< / a > < / li >
< li > < a href = "../shortcodes/badge/" > Marker badges< / a > < / li >
< li > < a href = "../shortcodes/button/" > Configur'ble buttons< / a > < / li >
2022-12-16 17:42:17 +00:00
< li > < a href = "../shortcodes/children/" > List child planks< / a > < / li >
2023-02-10 21:17:53 +00:00
< li > < a href = "../shortcodes/expand/" > Expand areas t' reveal rrrambl'n< / a > < / li >
< li > < a href = "../shortcodes/icon/" > Font Awesome ay'cons< / a > < / li >
< li > < a href = "../shortcodes/include/" > Inclusion o' other files< / a > < / li >
< li > < a href = "../shortcodes/math/" > Math an' chemical formulae us'n MathJax< / a > < / li >
< li > < a href = "../shortcodes/mermaid/" > Merrrmaid diagrams fer flowcharts, sequences, gantts, pie, etc.< / a > < / li >
< li > < a href = "../shortcodes/notice/" > Colorful boxes< / a > < / li >
< li > < a href = "../shortcodes/siteparam/" > Reveal ye site’ s configurat'n parameter< / a > < / li >
< li > < a href = "../shortcodes/swagger/" > Swagger UI fer yer OpenAPI Specificat'ns< / a > < / li >
< li > < a href = "../shortcodes/tabs/" > Tabbed panels< / a > < / li >
< / ul >
< / li >
< / ul >
< h2 id = "support" > Support< / h2 >
2022-12-23 11:24:54 +00:00
< p > T' get support, feel free t' open a new < a href = "https://github.com/McShelby/hugo-theme-relearn/discussions" target = "_blank" > discussion topic< / a > or < a href = "https://github.com/McShelby/hugo-theme-relearn/issues" target = "_blank" > issue report< / a > 'n th' official repository on GitHub.< / p >
2023-02-10 21:17:53 +00:00
< h2 id = "contributions" > Contribut'ns< / h2 >
< p > Feel free t' contribute t' this documentat'n by just click'n th'
2022-12-14 21:48:05 +00:00
< span class = "btn cstyle transparent" >
< button type = "button" >
< i class = "fa-fw fas fa-pen" > < / i >
< / button >
2023-02-10 21:58:51 +00:00
< / span > button displayed on top right o' each plank.< / p >
< p > Ye be most welcome t' contribute bugfixes or new features by mak'n pull requests t' th' < a href = "https://github.com/McShelby/hugo-theme-relearn" target = "_blank" > official repository< / a > . Check th' < a href = "../dev/contributing/" > contribut'n guidelines< / a > first before start'n.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "license" > License< / h2 >
2023-02-10 21:17:53 +00:00
< p > Th' Relearrrn theme be licensed under th' < a href = "https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE" target = "_blank" > MIT License< / a > .< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "credits" > Credits< / h2 >
2023-02-10 21:17:53 +00:00
< p > This theme would not be poss'ble without th' work o' < a href = "../more/credits/" > many others< / a > .< / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-07-14 20:20:11 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsct' ns o' Cap' n Hugo Relearrrn Theme< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "chapter" >
2022-07-05 22:16:52 +00:00
< div class = "article-subheading" > T' chapterrr 1< / div >
2022-11-13 21:34:47 +00:00
< h1 id = "basics" > Basics< / h1 >
2022-04-02 13:30:16 +00:00
< p > Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsct' ns o' Basics< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-12-14 21:48:05 +00:00
< h1 id = "whats-new" > What' s New< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-12-16 17:42:17 +00:00
< p > This document shows ye what’ s new 'n th' latest release. For a detailed list o' changes, see th' < a href = "../basics/history/" > history plank< / a > .< / p >
2023-01-23 22:49:15 +00:00
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.95.0< / span > < / span > Th' minimum required Cap'n Hugo version.< / p >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > A change that requires act'n by ye aft upgrad'n t' assure th' ship be still functional.< / p >
2023-01-23 22:49:15 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > A change 'n default behavior that may requires act'n by ye if ye want t' revert it.< / p >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Marks new behavior ye might find interest'n or comes configur'ble.< / p >
2023-01-28 10:59:37 +00:00
<!-- GH - ACTION - RELEASE - MILESTONE -->
2022-12-01 00:38:08 +00:00
< hr >
2023-02-08 23:54:12 +00:00
< h2 id = "5120-not-yet-released" > 5.12.0 (not yet released)< / h2 >
< ul >
2023-02-10 16:37:31 +00:00
< li >
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Support fer languages that be written right t' left (like Arabic) be now complete an' extended t' th' menu, th' top navigat'n bar an' print. This feature be not avail'ble 'n Internet Explorer 11.< / p >
< / li >
< li >
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' scrollbars be now colored accord'n t' their variant color scheme t' better fit into th' visuals.< / p >
< / li >
2023-02-08 23:54:12 +00:00
< / ul >
< hr >
2023-02-07 17:09:51 +00:00
< h2 id = "5110-2023-02-07" > 5.11.0 (2023-02-07)< / h2 >
2023-01-29 10:28:20 +00:00
< ul >
< li >
2023-02-04 00:55:05 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' theme removed th' popular < a href = "https://jquery.com" target = "_blank" > jQuery< / a > library from its distribut'n.< / p >
< p > In case ye made changes t' th' theme that be dependend on this library ye can place a copy o' jQuery into yer < code > static/js< / code > directory an' board it from yer own < code > layouts/partials/custom-header.html< / code > like this:< / p >
< div class = "highlight" > < 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" > script< / span > < span class = "na" > src< / span > < span class = "o" > =< / span > < span class = "s" > " {{" < / span > < span class = "na" > js< / span > < span class = "err" > /< / span > < span class = "na" > jquery< / span > < span class = "err" > .< / span > < span class = "na" > min< / span > < span class = "err" > .< / span > < span class = "na" > js< / span > < span class = "err" > " |< / span > < span class = "na" > relURL< / span > < span class = "err" > }}{{< / span > < span class = "na" > if< / span > < span class = "err" > $< / span > < span class = "na" > assetBust'n< / span > < span class = "err" > }}?{{< / span > < span class = "na" > now< / span > < span class = "err" > .< / span > < span class = "na" > Unix< / span > < span class = "err" > }}{{< / span > < span class = "na" > end< / span > < span class = "err" > }}" < / span > < span class = "na" > defer< / span > < span class = "p" > > < /< / span > < span class = "nt" > script< / span > < span class = "p" > > < / span >
< / span > < / span > < / code > < / pre > < / div > < / li >
< li >
2023-02-05 10:47:44 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > < a href = "../shortcodes/mermaid/#parameter" > Merrrmaid< / a > diagrams can now be configured fer pan an' zoom on site-, page-level or individually fer each graph.< / p >
2023-02-05 10:13:50 +00:00
< p > Th' default sett'n o' < code > on< / code > , 'n effect since 1.1.0, changed back t' < code > off< / code > as there was interference wit' scroll'n on mobile an' big planks.< / p >
< / li >
< li >
2023-02-04 21:34:28 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' theme be now cap'ble t' visually < a href = "../basics/customization/#adjust-to-os-settings" > adapt t' yer OS’ s light/dark mode sett'n< / a > .< / p >
< p > This be also th' new default sett'n if ye haven’ t configured < code > themeVariant< / code > 'n yer < code > config.toml< / code > .< / p >
2023-02-05 10:47:44 +00:00
< p > Additionally ye can configure th' variants t' be taken fer light/dark mode wit' th' new < code > themeVariantAuto< / code > parameter.< / p >
2023-02-04 22:38:52 +00:00
< p > This be not supported fer Internet Explorer 11, which still displays 'n th' < code > relearn-light< / code > variant.< / p >
2023-02-04 21:34:28 +00:00
< / li >
< li >
2023-02-03 07:58:48 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' JavaScript code fer handl'n image lightboxes (provided by < a href = "https://noelboss.github.io/featherlight" target = "_blank" > Featherlight< / a > ) was replaced by a CSS-only solut'n.< / p >
< p > This also changed th' < a href = "../cont/markdown/#lightbox" > lightbox effects< / a > parameter from < code > featherlight=false< / code > t' < code > lightbox=false< / code > . Nevertheless ye don’ t need t' change anyth'n as th' old name will be used as a fallback.< / p >
2023-01-30 11:58:02 +00:00
< / li >
2023-01-30 16:06:37 +00:00
< li >
2023-02-05 10:47:44 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' < a href = "../shortcodes/expand/" > < code > expand< / code > shortcode< / a > was changed. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.< / p >
< / li >
< li >
2023-02-02 22:52:14 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Translat'n fer Czech. This language be not supported fer search.< / p >
2023-01-30 16:06:37 +00:00
< / li >
2023-02-03 07:58:48 +00:00
< li >
2023-02-05 12:23:03 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > < a href = "https://github.com/McShelby/hugo-theme-relearn/tags" target = "_blank" > GitHub releases< / a > be also now tagged fer th' main version (eg. < code > 1.2.x< / code > ), major version (eg. < code > 1.x< / code > ) an' th' latest (just < code > x< / code > ) release mak'n it easier fer ye t' pin th' theme t' a certain version.< / p >
2023-02-03 07:58:48 +00:00
< / li >
2023-01-29 10:28:20 +00:00
< / ul >
< hr >
2023-01-25 12:06:07 +00:00
< h2 id = "5100-2023-01-25" > 5.10.0 (2023-01-25)< / h2 >
2023-01-23 22:49:15 +00:00
< ul >
2023-01-23 23:14:54 +00:00
< li >
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' < a href = "../shortcodes/attachments/" > < code > attachments< / code > < / a > , < a href = "../shortcodes/badge/" > < code > badge< / code > < / a > , < a href = "../shortcodes/button/" > < code > button< / code > < / a > an' < a href = "../shortcodes/notice/" > < code > notice< / code > < / a > shorrrtcodes have a new parameter < code > color< / code > t' set arbitrary CSS color values.< / p >
< p > Additionally th' < code > --ACCENT-color< / code > brand color introduced 'n version 5.8.0 be now supported wit' these shorrrtcodes.< / p >
< / li >
2023-01-23 22:49:15 +00:00
< / ul >
< hr >
2022-12-23 02:25:15 +00:00
< h2 id = "590-2022-12-23" > 5.9.0 (2022-12-23)< / h2 >
2022-12-14 21:19:05 +00:00
< ul >
2022-12-16 17:42:17 +00:00
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' required folder name fer th' < a href = "../shortcodes/attachments/" > < code > attachments< / code > shortcode< / a > was changed fer leaf bundles.< / p >
2022-12-23 02:25:15 +00:00
< p > Previously, th' attachments fer leaf bundles 'n non-multilang setups were required t' be 'n a < code > files< / code > subdirectory. For plank bundles an' leaf bundles 'n multilang setups they were always required t' be 'n a < code > _index.< LANGCODE> .files< / code > or < code > index.< LANGCODE> .files< / code > subdirectory accordingly.< / p >
< p > This added unnessessary complexity. So attachments fer leaf bundles 'n non-multilang setups can now also reside 'n a < code > index.files< / code > directory. Although th' old < code > files< / code > directory be now deprecated, if both directories be present, only th' old < code > files< / code > directory will be used fer compatiblity.< / p >
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Absolute links prefixed wit' < code > http://< / code > or < code > https://< / code > be now opened 'n a separate browser tab.< / p >
2022-12-26 01:00:35 +00:00
< p > Ye can revert back t' th' old behavior by defin'n < code > externalLinkTarget=" _self" < / code > 'n th' < code > params< / code > section o' yer < code > config.toml< / code > .< / p >
2022-12-16 17:42:17 +00:00
< / li >
< li >
2022-12-23 11:24:54 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' theme now supports < a href = "https://gohugo.io/hugo-modules/" target = "_blank" > Hugo’ s module system< / a > .< / p >
2022-12-16 17:42:17 +00:00
< / li >
2022-12-14 21:19:05 +00:00
< / ul >
< hr >
2022-12-08 10:17:57 +00:00
< h2 id = "580-2022-12-08" > 5.8.0 (2022-12-08)< / h2 >
2022-12-01 00:38:08 +00:00
< ul >
2022-12-02 15:21:29 +00:00
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' new < a href = "../shortcodes/badge/" > < code > badge< / code > shortcode< / a > be now avail'ble t' add highly configur'ble markers t' yer rrrambl'n as ye can see it on this plank.< / p >
2022-12-02 15:21:29 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' new < a href = "../shortcodes/icon/" > < code > ay'con< / code > shortcode< / a > simplyfies th' usage o' ay'cons. This can even be combined wit' also new < code > badge< / code > shortcode.< / p >
2022-12-02 17:32:53 +00:00
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' theme now supports some o' GFM (GitHub Flavored Markdown) rules an' Cap'n Hugo Marrrkdown extensions, namely < a href = "../cont/markdown/#tasks" > task lists< / a > , < a href = "../cont/markdown/#defintions" > defint'n lists< / a > an' < a href = "../cont/markdown/#footnotes" > footnotes< / a > .< / p >
2022-12-02 15:21:29 +00:00
< / li >
2022-12-02 19:45:52 +00:00
< li >
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > A new color < code > --ACCENT-color< / code > was introduced which be used fer highlightn'n search results on th' plank. In case ye simply don’ t care, ye don’ t need t' change anyth'n 'n yer variant stylesheet as th' old < code > yellow< / code > color be still used as default.< / p >
< / li >
2022-12-01 00:38:08 +00:00
< / ul >
2022-04-02 13:30:16 +00:00
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "570-2022-11-29" > 5.7.0 (2022-11-29)< / h2 >
2022-11-27 12:11:34 +00:00
< ul >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' Korean language translat'n fer this theme be now avail'ble wit' th' language code < code > ko< / code > . Formerly th' country code < code > kr< / code > was used instead.< / p >
2022-11-27 12:11:34 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' < a href = "../shortcodes/button/" > < code > button< / code > shortcode< / a > can now also be used as a real button inside o' HTML forms - although this be a pretty rare use case. Th' documentat'n was updated accordingly.< / p >
2022-11-28 17:44:03 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' search now supports th' Korean language.< / p >
2022-11-27 12:11:34 +00:00
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "560-2022-11-18" > 5.6.0 (2022-11-18)< / h2 >
2022-11-17 21:13:11 +00:00
< ul >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > This release introduces an additional dedicated search plank. On this plank, displayed search results have more space mak'n it easier scann'n thru large number o' results.< / p >
2022-12-16 17:42:17 +00:00
< p > T' activate this feature, ye need t' < a href = "../basics/configuration/#activate-dedicated-search-page" > configure it< / a > 'n yer < code > config.toml< / code > as a new outputformat < code > SEARCHPAGE< / code > fer th' home plank. If ye don’ t configure it, no dedicated search plank will be access'ble an' th' theme works as before.< / p >
2022-11-17 21:13:11 +00:00
< p > Ye can access th' search plank by either click'n on th' magnifier glass or press'n enter inside o' th' search box.< / p >
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Keyboard handl'n fer th' TOC an' search was improved.< / p >
2022-11-17 21:13:11 +00:00
< p > Press'n < code > CTRL+ALT+t< / code > now will not only toggle th' TOC overlay but also places th' focus t' th' first head'n on open'n. Subsequently this makes it poss'ble t' easily select head'ns by us'n th' < code > TAB< / code > key.< / p >
< p > Th' search received its own brand new keyboard shortcut < code > CTRL+ALT+f< / code > . This will focus th' cursor inside o' th' the search box so ye can immediately start yer search by typ'n.< / p >
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Ye be now able t' turn off th' generat'n o' generator meta tags 'n yer HTML head t' hide th' used versions o' Cap'n Hugo an' this theme.< / p >
2022-12-16 17:42:17 +00:00
< p > T' < a href = "../basics/configuration/#global-site-parameters" > configure this< / a > 'n yer < code > config.toml< / code > make sure t' set Hugo’ s < code > disableHugoGeneratorInject=true< / code > < strong > an'< / strong > also < code > [params] disableGeneratorVersion=true< / code > , otherwise Cap'n Hugo will generate a meta tag into yer home plank automagically.< / p >
2022-11-17 21:13:11 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Creat'n o' yer project gets a little bit faster wit' this release.< / p >
2022-11-17 21:13:11 +00:00
< p > This addresses increased build time wit' th' 5.x releases. Th' theme now heavily caches partial results lead'n t' improved performance. T' further increase performance, unnecessary parts o' th' plank be now skipped fer creat'n o' th' print output (eg. menus, navigat'n bar, etc.).< / p >
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "550-2022-11-06" > 5.5.0 (2022-11-06)< / h2 >
2022-11-06 15:27:13 +00:00
< ul >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' way images be processed has changed. Now images be lazy boarded by default which speeds up plank board on slow networks and/or big planks an' also th' print preview.< / p >
2022-12-16 17:42:17 +00:00
< p > For that th' JavaScript code t' handle th' < a href = "../cont/markdown/#further-image-formatting" > lightbox an' image effects< / a > on th' client side was removed 'n favour fer static generat'n o' those effects on th' server.< / p >
2022-11-06 15:27:13 +00:00
< p > If ye have used HTML directly 'n yer Marrrkdown files, this now has th' downside that it doesn’ t respect th' effect query parameter anymore. In this case ye have t' migrate all yer HTML < code > img< / code > URLs manually t' th' respective HTML attributes.< / p >
< table >
< thead >
< tr >
< th > Old< / th >
< th > New< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < code > < img src=" pic.png?width=20vw& classes=shadow,border" > < / code > < / td >
< td > < code > < img src=" pic.png" style=" width:20vw;" class=" shadow border" > < / code > < / td >
< / tr >
< / tbody >
< / table >
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "540-2022-11-01" > 5.4.0 (2022-11-01)< / h2 >
2022-10-31 13:52:10 +00:00
< ul >
2022-10-31 14:31:20 +00:00
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > < a href = "../basics/configuration/#serving-your-page-from-the-filesystem" > Wit' th' proper sett'ns< / a > 'n yer < code > config.toml< / code > yer plank be now serv'ble from th' local file system us'n < code > file://< / code > URLs.< / p >
2022-11-01 23:17:10 +00:00
< p > Please note that th' searchbox will only work fer this if ye reconfigure yer outputformat fer th' homepage 'n yer < code > config.toml< / code > from < code > JSON< / code > t' < code > SEARCH< / code > . Th' now deprecated < code > JSON< / code > outputformat still works as before, so there be no need t' reconfigure yer installat'n if it be only served from < code > http://< / code > or < code > https://< / code > .< / p >
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' < a href = "../shortcodes/button/" > < code > button< / code > shortcode< / a > has a new parameter < code > target< / code > t' set th' destinat'n frame/window fer th' URL t' open. If not given, it defaults t' a new window/tab fer external URLs or be not set at all fer internal URLs. Previously even internal URLs whar' opened 'n a new window/tab.< / p >
2022-10-31 20:10:53 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' < a href = "../shortcodes/math/" > < code > math< / code > shortcode< / a > an' < a href = "../shortcodes/mermaid/" > < code > mermaid< / code > shortcode< / a > now also support th' < code > align< / code > parameter if codefence rules be used.< / p >
2022-10-31 14:31:20 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Support fer languages that be written right t' left (like Arabic). This be only implemented fer th' rrrambl'n area but not th' navigat'n sidebar. This feature be not avail'ble 'n Internet Explorer 11.< / p >
2022-11-01 01:10:49 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Translat'n fer Finnish (Suomi).< / p >
2022-10-31 14:31:20 +00:00
< / li >
2022-10-31 13:52:10 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "530-2022-10-07" > 5.3.0 (2022-10-07)< / h2 >
2022-10-05 23:10:59 +00:00
< ul >
2022-10-06 20:51:16 +00:00
< li >
2023-02-03 07:58:48 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > In th' effort t' comply wit' WCAG standards, th' implementat'n o' th' collaps'ble menu was changed. Th' functionality o' th' new implementat'n does not work wit' old browsers (Internet Explorer 11).< / p >
2022-10-06 20:51:16 +00:00
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > < a href = "../cont/markdown/#add-css-classes" > Image formatt'n< / a > has two new classes t' align images t' th' < code > left< / code > or < code > right< / code > . Additionally, th' already exist'n < code > inline< / code > opt'n be now documented.< / p >
2022-10-08 19:39:32 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Print'n fer th' < a href = "../shortcodes/swagger/" > < code > swagger< / code > shortcode< / a > was optimized t' expand sections that be usually closed 'n interactive mode. This requires < a href = "../basics/configuration/#activate-print-support" > print support< / a > t' be configured.< / p >
2022-10-06 20:51:16 +00:00
< / li >
2022-10-05 23:10:59 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "520-2022-08-03" > 5.2.0 (2022-08-03)< / h2 >
2022-07-26 22:37:13 +00:00
< ul >
2022-12-01 00:38:08 +00:00
< li > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > If you’ ve set < code > collapsibleMenu = true< / code > 'n yer < code > config.toml< / code > , th' menu will be expanded if a search term be found 'n a collapsed submenu. Th' menu will return t' its initial collapse state once th' search term does not match any submenus.< / li >
2022-07-26 22:37:13 +00:00
< / ul >
2022-08-05 20:07:30 +00:00
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "510-2022-07-15" > 5.1.0 (2022-07-15)< / h2 >
2022-07-14 22:04:46 +00:00
< ul >
< li >
2023-01-23 22:49:15 +00:00
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.95.0< / span > < / span > This release requires a newer Cap'n Hugo version.< / p >
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Because th' print preview URLs were non deterministic fer normal planks 'n comparison t' plank bundles, this be now changed. Each print preview be now access'ble by add'n a < code > index.print.html< / code > t' th' default URL.< / p >
2022-07-14 22:04:46 +00:00
< p > Ye can revert this behavior by overwrit'n th' PRINT output format sett'n 'n yer < code > config.toml< / code > t':< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > outputFormats< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > outputFormats< / span > < span class = "p" > .< / span > < span class = "nx" > PRINT< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " PRINT" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > baseName< / span > < span class = "p" > =< / span > < span class = "s2" > " index" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > path< / span > < span class = "p" > =< / span > < span class = "s2" > " _print" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > isHTML< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mediaType< / span > < span class = "p" > =< / span > < span class = "s1" > ' text/html' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > permalink'ble< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < / code > < / pre > < / div > < / li >
< / ul >
2022-08-05 20:07:30 +00:00
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "500-2022-07-05" > 5.0.0 (2022-07-05)< / h2 >
2022-07-05 22:16:52 +00:00
< ul >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > Th' theme changed how JavaScript an' CSS dependencies be boarded t' provide a better performance. In case you’ ve added own JavaScript code that depends on th' themes jQuery implementat'n, ye have t' put it into a separate < code > *.js< / code > file (if not already) an' add th' < code > defer< / code > keyword t' th' < code > script< / code > element. Eg.< / p >
2022-07-07 22:11:05 +00:00
< div class = "highlight" > < 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" > script< / span > < span class = "na" > defer< / span > < span class = "na" > src< / span > < span class = "o" > =< / span > < span class = "s" > " myscript.js" < / span > < span class = "p" > > < /< / span > < span class = "nt" > script< / span > < span class = "p" > > < / span >
< / span > < / span > < / code > < / pre > < / div > < / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' way < a href = "../cont/archetypes/" > archetypes< / a > be used t' generate output has changed. Th' new systems allows ye, t' redefine exist'n archetypes or even generate yer own ones.< / p >
2022-07-05 22:16:52 +00:00
< p > Yer exist'n markdown files will still work like before an' therefore ye don’ t need t' change anyth'n aft th' upgrade. Nevertheless, it be recommended t' adapt yer exist'n markdown files t' th' new way as follows:< / p >
2022-07-02 12:20:53 +00:00
< ul >
2022-07-03 15:22:50 +00:00
< li >
2022-07-05 22:16:52 +00:00
< p > fer yer home plank, add th' frontmatter parameter < code > archetype = " home" < / code > an' remove th' lead'n head'n< / p >
< / li >
< li >
< p > fer all files contain'n th' deprecated frontmatter parameter < code > chapter = true< / code > , replace it wit' < code > archetype = " chapter" < / code > an' remove th' lead'n head'ns< / p >
< / li >
< / ul >
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' frontmatter opt'ns < code > pre< / code > / < code > post< / code > were renamed t' < code > menuPre< / code > / < code > menuPost< / code > . Th' old opt'ns will still be used if th' new opt'ns aren’ t set. Therefore ye don’ t need t' change anyth'n aft th' upgrade.< / p >
2022-07-03 15:22:50 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Add'n new partials < code > heading-pre.html< / code > / < code > heading-post.html< / code > an' accord'n frontmatter opt'ns < code > headingPre< / code > / < code > headingPost< / code > t' modify th' way yer page`s main head'n gets styled.< / p >
2022-07-03 15:22:50 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' new shortcode < code > math< / code > be avail'ble t' add beautiful math an' chemical formulae. See th' < a href = "../shortcodes/math/" > documentat'n< / a > fer avail'ble features. This feature will not work wit' Internet Explorer 11.< / p >
2022-07-03 15:22:50 +00:00
< / li >
2022-07-02 12:20:53 +00:00
< / ul >
2022-08-05 20:07:30 +00:00
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "420-2022-06-23" > 4.2.0 (2022-06-23)< / h2 >
2022-06-22 22:08:50 +00:00
< ul >
2022-06-22 22:13:57 +00:00
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > Th' second parameter fer th' < a href = "../shortcodes/include/" > < code > include< / code > shortcode< / a > was switched 'n mean'n an' was renamed from < code > showfirsthead'n< / code > t' < code > hidefirsthead'n< / code > . If ye haven’ t used this parameter 'n yer shortcode, th' default behavior hasn’ t changed an' ye don’ t need t' change anyth'n.< / p >
2022-10-31 14:06:51 +00:00
< p > If you’ ve used th' second boolean parameter, ye have t' rename it an' invert its value t' achieve th' same behavior.< / p >
2022-06-23 11:25:28 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Previously, if th' < a href = "../shortcodes/tabs/" > < code > tabs< / code > shortcode< / a > could not find a tab item because, th' tabs ended up empty. Now th' first tab be selected instead.< / p >
2022-06-22 22:13:57 +00:00
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Th' < code > landingPageURL< / code > was removed from < code > config.toml< / code > . Ye can safely remove this as well from yer configurat'n as it be not used anymore. Th' theme will detect th' land'n plank URL automatically.< / p >
2022-06-23 12:10:55 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > All shorrrtcodes can now be also called from yer partials. Examples fer this be added t' th' documentat'n o' each shortcode.< / p >
2022-06-22 22:13:57 +00:00
< / li >
2022-06-22 22:08:50 +00:00
< / ul >
2022-08-05 20:07:30 +00:00
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "410-2022-06-12" > 4.1.0 (2022-06-12)< / h2 >
2022-06-12 17:25:16 +00:00
< ul >
2022-12-16 17:42:17 +00:00
< li > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > While fix'n issues wit' th' search functionality fer non Latin languages, ye can now < a href = "../cont/i18n/#search-with-mixed-language-support" > configure t' have multiple languages on a single plank< / a > .< / li >
2022-06-12 17:25:16 +00:00
< / ul >
2022-08-05 20:07:30 +00:00
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "400-2022-06-05" > 4.0.0 (2022-06-05)< / h2 >
2022-05-22 22:01:22 +00:00
< ul >
2022-05-23 05:44:07 +00:00
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > Th' < code > custom_css< / code > config parameter was removed from th' configurat'n. If used 'n an exist'n installat'n, it can be achieved by overrid'n th' < code > custom-header.html< / code > template 'n a much more generic manner.< / p >
2022-05-23 05:44:07 +00:00
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > Because anchor hover color was not configur'ble without introduc'n more complexity t' th' variant stylesheets, we decided t' remove < code > --MAIN-ANCHOR-color< / code > instead. Ye don’ t need t' change anyth'n 'n yer custom color stylesheet as th' anchors now get their colors from < code > --MAIN-LINK-color< / code > an' < code > --MAIN-ANCHOR-HOVER-color< / code > respectively.< / p >
2022-05-28 22:16:25 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > All shorrrtcodes now support named parameter. Th' positional parameter be still supported but will not be enhanced wit' new features, so ye don’ t need t' change anyth'n 'n yer installat'n.< / p >
2022-12-16 17:42:17 +00:00
< p > This applies t' < a href = "../shortcodes/expand/" > < code > expand< / code > < / a > , < a href = "../shortcodes/include/" > < code > include< / code > < / a > , < a href = "../shortcodes/notice/" > < code > notice< / code > < / a > an' < a href = "../shortcodes/siteparam/" > < code > siteparam< / code > < / a > .< / p >
2022-05-29 21:00:53 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' < a href = "../shortcodes/button/" > < code > button< / code > < / a > shortcode received some love an' now has a parameter fer th' color style similar t' other shorrrtcodes.< / p >
2022-05-29 21:00:53 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > New colors < code > --PRIMARY-color< / code > an' < code > --SECONDARY-color< / code > were added t' provide easier modificat'n o' yer custom style. Shorrrtcodes wit' a color style can now have < code > primary< / code > or < code > secondary< / code > as additional values.< / p >
2022-05-29 21:00:53 +00:00
< p > These two colors be th' default fer other, more specific color variables. Ye don’ t need t' change anyth'n 'n yer exist'n custom color stylesheets as those variables get reason'ble default values.< / p >
2022-05-23 05:44:07 +00:00
< / li >
2022-06-05 17:32:37 +00:00
< li >
2023-02-02 22:52:14 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Translat'n fer Polish. This language be not supported fer search.< / p >
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' documentat'n fer all shorrrtcodes were revised.< / p >
2022-06-05 17:32:37 +00:00
< / li >
2022-05-22 22:01:22 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "340-2022-04-03" > 3.4.0 (2022-04-03)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > If ye had previously overwritten th' < code > custom-footer.html< / code > partial t' add visual elements below th' rrrambl'n o' yer plank, ye have t' move this rrrambl'n t' th' new partial < code > content-footer.html< / code > . < code > custom-footer.html< / code > was never meant t' contain HTML other than additional styles an' JavaScript.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > If ye prefer expandable/collaps'ble menu items, ye can now set < code > collapsibleMenu=true< / code > 'n yer < code > config.toml< / code > . This will add arrows t' all menu items that contain sub menus. Th' menu will expand/collapse without navigat'n if ye click on an arrow.< / p >
2022-04-03 10:12:47 +00:00
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Ye can activate < a href = "../basics/configuration/#activate-print-support" > print support< / a > 'n yer < code > config.toml< / code > t' add th' capability t' print whole chapters or even th' complete ship.< / p >
2022-04-02 13:30:16 +00:00
< / li >
2022-04-03 10:26:58 +00:00
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Translat'n fer Traditional Chinese.< / p >
2022-04-03 10:26:58 +00:00
< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "330-2022-03-28" > 3.3.0 (2022-03-28)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Introduct'n o' new CSS variables t' set th' font. Th' theme distinguishes between < code > --MAIN-font< / code > fer all rrrambl'n text an' < code > --CODE-font< / code > fer inline or block code. There be additional overrides fer all head'ns. See th' < a href = "../basics/generator/" > theme variant generator< / a > o' th' exampleSite fer all avail'ble variables.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' new shortcode < code > swagger< / code > be avail'ble t' include a UI fer REST OpenAPI Specificat'ns. See th' < a href = "../shortcodes/swagger/" > documentat'n< / a > fer avail'ble features. This feature will not work wit' Internet Explorer 11.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "320-2022-03-19" > 3.2.0 (2022-03-19)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
< li >
2023-01-23 22:49:15 +00:00
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.93.0< / span > < / span > This release requires a newer Cap'n Hugo version.< / p >
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > In this release th' Merrrmaid JavaScript library will only be boarded on demand if th' plank contains a Merrrmaid shortcode or be us'n Merrrmaid codefences. This changes th' behavior o' < code > disableMermaid< / code > config opt'n as follows: If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' Merrrmaid will be boarded regardlessly.< / p >
< p > Th' opt'n be still useful 'n case ye be us'n script'n t' set up yer graph. In this case no shortcode or codefence be involved an' th' library be not boarded by default. In this case ye can set < code > disableMermaid=false< / code > 'n yer frontmatter t' force th' library t' be boarded. See th' < a href = "../basics/generator/" > theme variant generator< / a > o' th' exampleSite fer an example.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Additional color variant vari'ble < code > --MERMAID-theme< / code > t' set th' variant’ s Merrrmaid theme. This causes th' Merrrmaid theme t' switch wit' th' color variant if it defers from th' sett'n o' th' formerly selected color variant.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "310-2022-03-15" > 3.1.0 (2022-03-15)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > < a href = "../shortcodes/attachments/" > < code > attachment< / code > < / a > an' < a href = "../shortcodes/notice/" > < code > notice< / code > < / a > shorrrtcodes have a new parameter t' override th' default ay'con. Allowed values be all < a href = "https://fontawesome.com/v5/search?m=free" target = "_blank" > Font Awesome 5 Free< / a > ay'cons.< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "300-2022-02-22" > 3.0.0 (2022-02-22)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > We made changes t' th' menu footer. If ye have yer < code > menu-footer.html< / code > < a href = "../basics/customization/" > partial overridden< / a > , ye may have t' review th' styl'n (eg. margins/paddings) 'n yer partial. For a reference take a look into th' < code > menu-footer.html< / code > partial that be com'n wit' th' exampleSite.< / p >
2022-04-02 13:30:16 +00:00
< p > This change was made t' allow yer own menu footer t' be placed right aft th' so called prefooter that comes wit' th' theme (contain'n th' language switch an' < em > Clear history< / em > functionality).< / p >
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > We have changed th' default colors from th' original Learrrn theme (the purple menu header) t' th' Relearrrn defaults (the light green menu header) as used 'n th' official documentat'n.< / p >
2022-12-16 17:42:17 +00:00
< p > This change will only affect yer installat'n if you’ ve not set th' < code > themeVariant< / code > parameter 'n yer < code > config.toml< / code > . < a href = "../basics/customization/#theme-variant" > If ye still want t' use th' Learrrn color variant< / a > , ye have t' explicitly set < code > themeVariant=" learn" < / code > 'n yer < code > config.toml< / code > .< / p >
2022-04-02 13:30:16 +00:00
< p > Avast, that this will also affect yer ship if viewed wit' Internet Explorer 11 but 'n this case it can not be reconfigured as Internet Explorer does not support CSS variables.< / p >
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Due t' a bug, that we couldn’ t fix 'n a general manner fer color variants, we decided t' remove < code > --MENU-SEARCH-BOX-ICONS-color< / code > an' introduced < code > --MENU-SEARCH-color< / code > instead. Ye don’ t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > For consistency reasons, we renamed < code > --MENU-SEARCH-BOX-color< / code > t' < code > --MENU-SEARCH-BORDER-color< / code > . Ye don’ t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Wit' this release ye be now cap'ble t' define yer own < em > dark mode< / em > variants.< / p >
2022-12-16 17:42:17 +00:00
< p > T' make this poss'ble, we have introduced a lot more color variables ye can use 'n < a href = "../basics/customization/#theme-variant" > yer color variants< / a > . Yer old variants will still work an' don’ t need t' be changed as appropriate fallback values be used by th' theme. Nevertheless, th' new colors allow fer much more customizat'n.< / p >
2022-04-02 13:30:16 +00:00
< p > T' see what’ s now poss'ble, see th' new variants < code > relearn-dark< / code > an' < code > neon< / code > that be com'n wit' this release.< / p >
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > T' make th' creat'n o' new variants easier fer ye, we’ ve added a new interactive < a href = "../basics/generator/" > theme variant generator< / a > . This feature will not work wit' Internet Explorer 11.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Ye can now configure multiple color variants 'n yer < code > config.toml< / code > . In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer. See th' < a href = "../basics/customization/#multiple-variants" > documentat'n< / a > fer configurat'n.< / p >
2022-04-02 13:30:16 +00:00
< p > Avast, that th' new variant switch will not work wit' Internet Explorer 11 as it does not support CSS variables. Therefore, th' variant switcher will not be displayed wit' Internet Explorer 11.< / p >
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "290-2021-11-19" > 2.9.0 (2021-11-19)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > This release removes th' themes implementat'n o' < code > ref< / code > /< code > relref< / code > 'n favor fer Hugos standard implementat'n. This be because o' inconsistencies wit' th' themes implementat'n. In advantage, yer project becomes standard compliant an' exchang'n this theme 'n yer project t' some other theme will be effortless.< / p >
2022-10-31 14:06:51 +00:00
< p > In a standard compliant form ye must not link t' th' < code > *.md< / code > file but t' its logical name. You’ ll see, referenc'n other planks becomes much easier. All three types result 'n th' same reference:< / p >
2022-04-02 13:30:16 +00:00
< table >
< thead >
< tr >
< th > Type< / th >
< th > Non-Standard< / th >
< th > Standard< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > Branch bundle< / td >
< td > < code > basics/configuration/_index.md< / code > < / td >
< td > < code > basics/configurat'n< / code > < / td >
< / tr >
< tr >
< td > Leaf bundle< / td >
< td > < code > basics/configuration/index.md< / code > < / td >
< td > < code > basics/configurat'n< / code > < / td >
< / tr >
< tr >
< td > Plank< / td >
< td > < code > basics/configurat'n.md< / code > < / td >
< td > < code > basics/configurat'n< / code > < / td >
< / tr >
< / tbody >
< / table >
2022-12-23 11:24:54 +00:00
< p > If you’ ve linked from a plank o' one language t' a plank o' another language, conversion be a bit more difficult but < a href = "https://gohugo.io/content-management/cross-references/#link-to-another-language-version" target = "_blank" > Cap'n Hugo got ye covered< / a > as well.< / p >
< p > Also, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugos implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can < a href = "https://gohugo.io/content-management/cross-references/#link-to-another-language-version" target = "_blank" > reconfigure th' error handl'n< / a > o' Hugos implementat'n.< / p >
2022-10-31 14:06:51 +00:00
< p > In th' best case yer usage o' th' old implementat'n be already standard compliant an' ye don’ t need t' change anyth'n. You’ ll notice this very easily once you’ ve started < code > hugo server< / code > aft an upgrade an' no errors be written t' th' console.< / p >
2022-04-02 13:30:16 +00:00
< p > Ye may see errors on th' console aft th' update 'n th' form:< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-sh" data-lang = "sh" > < span class = "line" > < span class = "cl" > ERROR 2021/11/19 22:29:10 < span class = "o" > [< / span > en< span class = "o" > ]< / span > REF_NOT_FOUND: Ref < span class = "s2" > " basics/configuration/_index.md" < / span > : < span class = "s2" > " hugo-theme-relearn\exampleSite\content\_index.en.md:19:22" < / span > : plank not found
< / span > < / span > < / code > < / pre > < / div > < p > In this case, ye must apply one o' two opt'ns:< / p >
< ol >
< li >
< p > Copy th' old implementat'n files < code > theme/hugo-theme-relearn/layouts/shortcode/ref.html< / code > an' < code > theme/hugo-theme-relearn/layouts/shortcode/relref.html< / code > t' yer own projects < code > layouts/shortcode/ref.html< / code > an' < code > layouts/shortcode/relref.html< / code > respectively. < strong > This be not recommended< / strong > as yer project will still rely on non-standard behavior afterwards.< / p >
< / li >
< li >
< p > Start up a text editor wit' regular expression support fer search an' replace. Apply th' follow'n conversions 'n th' given order on all < code > *.md< / code > files. < strong > This be th' recommended choice< / strong > .< / p >
< / li >
< / ol >
< table >
< thead >
< tr >
< th > Type< / th >
< th > Search< / th >
< th > Replace by< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > Branch bundle< / td >
< td > < code > (ref\s+" [^" ]*)/_index\.md" < / code > < / td >
< td > < code > $1" < / code > < / td >
< / tr >
< tr >
< td > Leaf bundle< / td >
< td > < code > (ref\s+" [^" ]*)/index\.md" < / code > < / td >
< td > < code > $1" < / code > < / td >
< / tr >
< tr >
< td > Plank< / td >
< td > < code > (ref\s+" [^" ]*)\.md" < / code > < / td >
< td > < code > $1" < / code > < / td >
< / tr >
< / tbody >
< / table >
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "280-2021-11-03" > 2.8.0 (2021-11-03)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Although never officially documented, this release removes th' font < code > Novacento< / code > /< code > Novecento< / code > . If ye use it 'n an overwritten CSS please replace it wit' < code > Work Sans< / code > . This change was necessary as Novacento did not provide all Latin special characters an' lead t' mixed styled character text eg. fer Czech.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' theme now supports favicons served from < code > static/images/< / code > named as < code > favicon< / code > or < code > logo< / code > 'n SVG, PNG or ICO format < a href = "../basics/customization/#change-the-favicon" > out o' th' box< / a > . An overridden partial < code > layouts/partials/favicon.html< / code > may not be necessary anymore 'n most cases.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Ye can hide th' t'ble o' contents menu fer th' whole ship by sett'n th' < code > disableToc< / code > opt'n 'n yer < code > config.toml< / code > . For an example see < a href = "../basics/configuration/#global-site-parameters" > th' example configurat'n< / a > .< / p >
2022-04-02 13:30:16 +00:00
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "270-2021-10-24" > 2.7.0 (2021-10-24)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
2023-01-24 22:59:44 +00:00
< li > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Optional second parameter fer < a href = "../shortcodes/notice/" > < code > notice< / code > < / a > shortcode t' set title 'n box header.< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "260-2021-10-21" > 2.6.0 (2021-10-21)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-16 17:42:17 +00:00
< li > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Yer ship can now be served from a subfolder if ye set < code > baseURL< / code > an' < code > canonifyURLs=true< / code > 'n yer < code > config.toml< / code > . See th' < a href = "../basics/configuration/#a-word-on-running-your-site-in-a-subfolder" > documentat'n< / a > fer a detailed example.< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "250-2021-10-08" > 2.5.0 (2021-10-08)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-01 00:38:08 +00:00
< li > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > New colors < code > --CODE-BLOCK-color< / code > an' < code > --CODE-BLOCK-BG-color< / code > were added t' provide a fallback fer Hugos rules highlight'n 'n case < code > guessSyntax=true< / code > be set. Ideally th' colors be set t' th' same values as th' ones from yer chosen chroma style.< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "240-2021-10-07" > 2.4.0 (2021-10-07)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Creat'n o' customized stylesheets was simplified down t' only contain th' CSS variables. Everyth'n else can an' should be deleted from yer custom stylesheet t' assure everyth'n works fine. For th' predefined stylesheet variants, this change be already included.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Hidden planks be displayed by default 'n their accord'n tags plank. Ye can now turn off this behavior by sett'n < code > disableTagHiddenPages=true< / code > 'n yer < code > config.toml< / code > .< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Ye can define th' expansion state o' yer menus fer th' whole ship by sett'n th' < code > alwaysopen< / code > opt'n 'n yer < code > config.toml< / code > . Please see further < a href = "../cont/pages/#override-expand-state-rules-for-menu-entries" > documentat'n< / a > fer poss'ble values an' default behavior.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > New frontmatter < code > ordersectionsby< / code > opt'n t' change immediate children sort'n 'n menu an' < code > children< / code > shortcode. Poss'ble values be < code > title< / code > or < code > weight< / code > .< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-23 11:24:54 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Alternate rrrambl'n o' a plank be now advertised 'n th' HTML meta tags. See < a href = "https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head" target = "_blank" > Cap'n Hugo documentat'n< / a > .< / p >
2022-04-02 13:30:16 +00:00
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "230-2021-09-13" > 2.3.0 (2021-09-13)< / h2 >
2022-04-03 20:10:42 +00:00
< ul >
2023-01-23 22:49:15 +00:00
< li >
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.81.0< / span > < / span > This release requires a newer Cap'n Hugo version.< / p >
< / li >
< li >
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Showcase multilanguage features by provid'n a documentat'n translat'n “ fer us pirrrates” . There will be no other translat'ns besides th' original English one an' th' Pirates one due t' maintenance constraints.< / p >
< / li >
2022-04-03 20:10:42 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "220-2021-09-09" > 2.2.0 (2021-09-09)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-01 08:14:48 +00:00
< li > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Hidden planks be displayed by default 'n th' sitemap generated by Cap'n Hugo an' be therefore vis'ble fer search engine index'n. Ye can now turn off this behavior by sett'n < code > disableSeoHiddenPages=true< / code > 'n yer < code > config.toml< / code > .< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "210-2021-09-07" > 2.1.0 (2021-09-07)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
< li >
2023-01-23 22:49:15 +00:00
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.69.0< / span > < / span > This release requires a newer Cap'n Hugo version.< / p >
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > In case th' site’ s structure contains additional *.md files not part o' th' ship (eg files that be meant t' be included by ship planks - see < code > CHANGELOG.md< / code > 'n th' exampleSite), they will now be ignored by th' search.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Hidden planks be indexed fer th' ship search by default. Ye can now turn off this behavior by sett'n < code > disableSearchHiddenPages=true< / code > 'n yer < code > config.toml< / code > .< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > If a search term be found 'n an < code > expand< / code > shortcode, th' expand will be opened.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 08:14:48 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Th' menu will scroll th' active item into view on board.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "200-2021-08-28" > 2.0.0 (2021-08-28)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
< li >
2022-12-23 11:24:54 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Rules highlight'n was switched t' th' < a href = "https://gohugo.io/content-management/syntax-highlighting/" target = "_blank" > built 'n Hugo mechanism< / a > . Ye may need t' configure a new stylesheet or decide t' roll ye own as described on 'n th' Cap'n Hugo documentat'n< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > In th' predefined stylesheets there was a typo an' < code > --MENU-HOME-LINK-HOVERED-color< / code > must be changed t' < code > --MENU-HOME-LINK-HOVER-color< / code > . Ye don’ t need t' change anyth'n 'n yer custom color stylesheet as th' old name will be used as a fallback.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > < code > --MENU-HOME-LINK-color< / code > an' < code > --MENU-HOME-LINK-HOVER-color< / code > were miss'n 'n th' documentat'n. Ye should add them t' yer custom stylesheets if ye want t' override th' defaults.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > Arrow navigat'n an' < code > children< / code > shortcode were ignor'n sett'n fer < code > ordersectionsby< / code > . This be now changed an' may result 'n different sort'n order o' yer sub planks.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > If hidden planks be accessed directly by typ'n their URL, they will be exposed 'n th' menu.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > < / span > < span class = "badge-content" > Change< / span > < / span > A plank without a < code > title< / code > will be treated as < code > hidden=true< / code > .< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Ye can define th' expansion state o' yer menus 'n th' frontmatter. Please see further < a href = "../cont/pages/#override-expand-state-rules-for-menu-entries" > documentat'n< / a > fer poss'ble values an' default behavior.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2022-12-16 17:42:17 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > New partials fer defin'n pre/post rrrambl'n fer menu items an' th' rrrambl'n. See < a href = "../basics/customization/" > documentat'n< / a > fer further read'n.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Shortcode < a href = "../shortcodes/children/" > < code > children< / code > < / a > wit' new parameter < code > containerstyle< / code > .< / p >
2022-04-02 13:30:16 +00:00
< / li >
< li >
2023-01-24 22:59:44 +00:00
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > New shortcode < a href = "../shortcodes/include/" > < code > include< / code > < / a > t' include arbitrary file rrrambl'n into a plank.< / p >
2022-04-02 13:30:16 +00:00
< / li >
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "120-2021-07-26" > 1.2.0 (2021-07-26)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
2023-01-24 22:59:44 +00:00
< li > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Shortcode < a href = "../shortcodes/expand/" > < code > expand< / code > < / a > wit' new parameter t' open on plank board.< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "110-2021-07-02" > 1.1.0 (2021-07-02)< / h2 >
2022-04-02 13:30:16 +00:00
< ul >
2023-02-05 10:13:50 +00:00
< li >
< p > < span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > < / span > < span class = "badge-content" > Break'n< / span > < / span > < a href = "../shortcodes/mermaid/" > Merrrmaid< / a > diagrams can now be panned an' zoomed. This isn’ t configur'ble yet.< / p >
< / li >
< li >
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > < a href = "../shortcodes/mermaid/#configuration" > < code > Merrrmaid< / code > < / a > config opt'ns can be set 'n < code > config.toml< / code > .< / p >
< / li >
2022-04-03 20:03:49 +00:00
< / ul >
< hr >
2022-12-04 22:22:32 +00:00
< h2 id = "100-2021-07-01" > 1.0.0 (2021-07-01)< / h2 >
2022-04-03 20:03:49 +00:00
< ul >
2023-01-23 22:49:15 +00:00
< li >
2023-02-05 12:38:34 +00:00
< p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.65.0< / span > < / span > Th' requirement fer th' Cap'n Hugo version o' this theme be th' same as fer th' Learrrn theme version 2.5.0 on 2021-07-01.< / p >
2023-01-23 22:49:15 +00:00
< / li >
< li >
< p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-plus-circle" > < / i > < / span > < span class = "badge-content" > New< / span > < / span > Initial fork o' th' < a href = "https://github.com/matcornic/hugo-theme-learn" target = "_blank" > Learrrn theme< / a > based on Learrrn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename t' < code > Relearrrn< / code > an' a new logo. For th' reasons behind fork'n th' Learrrn theme, see < a href = "https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495" target = "_blank" > this comment< / a > 'n th' Learrrn issues.< / p >
< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "requirrrements" > Requirrrements< / h1 >
2022-06-24 06:12:20 +00:00
2022-07-05 22:16:52 +00:00
2022-06-24 06:12:20 +00:00
< p > Thanks t' th' simplicity o' Cap'n Hugo, this plank be as empty as this theme needs requirements.< / p >
2023-01-28 16:56:24 +00:00
< p > Just download at least version < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > 0.95.0< / span > < / span > o' th' < a href = "https://gohugo.io/getting-started/installing/" target = "_blank" > Cap'n Hugo binary< / a > fer yer OS (Windows, Linux, Mac).< / p >
2022-11-05 23:35:48 +00:00
< p >
2023-02-10 23:05:55 +00:00
< a href = "#image-e7ab4149e3639e8d8adf9aa1751d02bb" class = "lightbox-link" >
2022-11-19 01:02:45 +00:00
< img src = "../basics/requirements/magic.gif?classes=shadow" alt = "Magic" class = "shadow" style = "height: auto; width: auto;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-e7ab4149e3639e8d8adf9aa1751d02bb" >
2023-02-04 15:22:06 +00:00
< img src = "../basics/requirements/magic.gif?classes=shadow" alt = "Magic" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-06-24 06:12:20 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "installatn" > Installat' n< / h1 >
2022-06-24 06:12:20 +00:00
2022-07-05 22:16:52 +00:00
2022-12-23 11:24:54 +00:00
< p > Th' follow'n steps be here t' help ye initialize yer new website. If ye don’ t know Cap'n Hugo at all, we strongly suggest ye learn more about it by follow'n this < a href = "https://gohugo.io/overview/quickstart/" target = "_blank" > great documentat'n fer beginners< / a > .< / p >
2022-06-24 06:12:20 +00:00
< h2 id = "create-your-project" > Create yer project< / h2 >
< p > Cap'n Hugo provides a < code > new< / code > command t' create a new website.< / p >
< pre tabindex = "0" > < code > hugo new ship < new_project>
< / code > < / pre > < h2 id = "install-the-theme" > Install th' theme< / h2 >
2022-12-23 11:24:54 +00:00
< p > Install th' Relearrrn theme by follow'n < a href = "https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme" target = "_blank" > this documentat'n< / a > us'n Hugo’ s module system.< / p >
< p > This theme’ s repository be: < a href = "https://github.com/McShelby/hugo-theme-relearn.git" target = "_blank" > https://github.com/McShelby/hugo-theme-relearn.git< / a > < / p >
< p > Alternatively, ye can < a href = "https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" target = "_blank" > download th' theme as .zip< / a > file an' extract it 'n th' < code > themes< / code > directory< / p >
2023-02-05 12:23:03 +00:00
< h3 id = "from-git" > From Git< / h3 >
< p > If ye install th' theme from yer git repository or GitHub, ye have several opt'ns.< / p >
< p > If ye use th' < code > head< / code > o' th' < code > main< / code > branch, ye be us'n th' development version. Usually it be fully functional but can break from time t' time. We try t' fix newly introduced bugs 'n this version as soon as poss'ble.< / p >
< p > Additionally ye can checkout one o' th' tagged versions. These tagged versions correspond t' an official < a href = "https://github.com/McShelby/hugo-theme-relearn/releases" target = "_blank" > releases from th' GitHub repository< / a > .< / p >
< p > Besides th' usual version tags (eg < code > 1.2.3< / code > ) there be also tags fer th' main version (eg. < code > 1.2.x< / code > ), major version (eg. < code > 1.x< / code > ) an' th' latest (just < code > x< / code > ) released version mak'n it easier fer ye t' pin th' theme t' a certain version.< / p >
2022-06-24 06:12:20 +00:00
< h2 id = "basic-configuration" > Basic configurat'n< / h2 >
< p > When build'n th' website, ye can set a theme by us'n < code > --theme< / code > opt'n. However, we suggest ye modify th' configurat'n file (< code > config.toml< / code > ) an' set th' theme as th' default. Ye can also add th' < code > [outputs]< / code > section t' en'ble th' search functionality.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "c" > # Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > theme< / span > < span class = "p" > =< / span > < span class = "s2" > " hugo-theme-relearn" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # For search functionality< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > outputs< / span > < span class = "p" > ]< / span >
2022-11-01 23:17:10 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > home< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " SEARCH" < / span > < span class = "p" > ]< / span >
2022-06-24 06:12:20 +00:00
< / span > < / span > < / code > < / pre > < / div > < h2 id = "create-your-first-chapter-page" > Create yer first chapter plank< / h2 >
< p > Chapters be planks that contain other child planks. It has a special layout style an' usually just contains a < em > chapter name< / em > , th' < em > title< / em > an' a < em > brief abstract< / em > o' th' section.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "gu" > ### Chapter 1
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gh" > # Basics
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gh" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.
< / span > < / span > < / code > < / pre > < / div > < p > renders as< / p >
2022-11-05 23:35:48 +00:00
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-e84d3d6e16645e404e4174e752bafe3d" class = "lightbox-link" >
2022-11-06 15:27:13 +00:00
< img src = "../basics/installation/chapter.png?classes=shadow&width=60pc" alt = "A Chapter" class = "shadow" style = "height: auto; width: 60pc;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-e84d3d6e16645e404e4174e752bafe3d" >
2023-02-04 15:22:06 +00:00
< img src = "../basics/installation/chapter.png?classes=shadow&width=60pc" alt = "A Chapter" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-06-24 06:12:20 +00:00
< p > Th' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind chapter basics/_index.md
< / span > < / span > < / code > < / pre > < / div > < p > By open'n th' given file, ye should see th' property < code > chapter=true< / code > on top, mean'n this plank be a < em > chapter< / em > .< / p >
< p > By default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property < code > draft: true< / code > from th' metadata.< / p >
< h2 id = "create-your-first-content-pages" > Create yer first rrrambl'n planks< / h2 >
< p > Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new basics/first-content.md
< / span > < / span > < span class = "line" > < span class = "cl" > hugo new basics/second-content/_index.md
< / span > < / span > < / code > < / pre > < / div > < p > Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' < code > title< / code > value 'n th' beginn'n o' th' files.< / p >
< h2 id = "launching-the-website-locally" > Launch'n th' website locally< / h2 >
< p > Launch by us'n th' follow'n command:< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo serve
< / span > < / span > < / code > < / pre > < / div > < p > Go t' < code > http://localhost:1313< / code > < / p >
< p > Ye should notice three th'ns:< / p >
< ol >
< li > Ye have a left-side < strong > Basics< / strong > menu, contain'n two submenus wit' names equal t' th' < code > title< / code > properties 'n th' previously created files.< / li >
< li > Th' home plank explains how t' cust'mize it by follow'n th' instruct'ns.< / li >
< li > When ye run < code > hugo serve< / code > , when th' contents o' th' files change, th' plank automatically refreshes wit' th' changes. Neat!< / li >
< / ol >
< h2 id = "build-the-website" > Build th' website< / h2 >
< p > When yer ship be ready t' deploy, run th' follow'n command:< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo
< / span > < / span > < / code > < / pre > < / div > < p > A < code > public< / code > folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.< / p >
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > This website can be automatically published an' hosted wit' < a href = "https://www.netlify.com/" target = "_blank" > Netlify< / a > (Read more about < a href = "https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/" target = "_blank" > Automated HUGO deployments wit' Netlify< / a > ). Alternatively, ye can use < a href = "https://gohugo.io/hosting-and-deployment/hosting-on-github/" target = "_blank" > GitHub planks< / a > .< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-06-24 06:12:20 +00:00
< / div >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "configurrratn" > Configurrrat' n< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< h2 id = "global-site-parameters" > Global ship parameters< / h2 >
2022-12-23 11:24:54 +00:00
< p > On top o' < a href = "https://gohugo.io/overview/configuration/" target = "_blank" > Cap'n Hugo global configurat'n< / a > , th' Relearrrn theme lets ye define th' follow'n parameters 'n yer < code > config.toml< / code > (here, values be default).< / p >
2022-04-02 13:30:16 +00:00
< p > Avast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # This controls whether submenus will be expanded (true), or collapsed (false) 'n th'< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # menu; if no sett'n be given, th' first menu level be set t' false, all others t' true;< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # this can be overridden 'n th' planks frontmatter< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Prefix URL t' edit current plank. Will display an " Edit" button on top right hand corner o' every plank.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Useful t' give opportunity t' people t' create merge request fer yer doc.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # See th' config.toml file from this documentat'n ship t' have an example.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > editURL< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Author o' th' ship, will be used 'n meta informat'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > author< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Descript'n o' th' ship, will be used 'n meta informat'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > descript'n< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Shows a checkmark fer visited planks on th' menu< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > showVisitedLinks< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Dis'ble search funct'n. It will hide search bar< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableSearch< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Dis'ble search 'n hidden planks, otherwise they will be shown 'n search box< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableSearchHiddenPages< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Disables hidden planks from show'n up 'n th' sitemap an' on Google (et all), otherwise they may be indexed by search engines< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableSeoHiddenPages< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Disables hidden planks from show'n up on th' tags plank although th' tag term will be displayed even if all planks be hidden< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableTagHiddenPages< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Javascript an' CSS cache be automatically busted when new version o' ship be generated.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Set this t' true t' dis'ble this behavior (some proxies don' t handle well this optimization)< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableAssetsBust'n< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
2022-11-13 12:17:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Set this t' true if ye want t' dis'ble generat'n fer generator version meta tags o' hugo an' th' theme;< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # don' t forget t' also set Hugo' s disableHugoGeneratorInject=true, otherwise it will generate a meta tag into yer home plank< / span >
2022-11-13 12:14:12 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableGeneratorVersion< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Set this t' true t' dis'ble copy-to-clipboard button fer inline code.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableInlineCopyToClipBoard< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # A title fer shortcuts 'n menu be set by default. Set this t' true t' dis'ble it.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableShortcutsTitle< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set t' false, a Home button will appear below th' search bar on th' menu.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # It be redirect'n t' th' land'n plank o' th' current language if specified. (Default be " /" )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableLandingPageButton< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # When us'n mulitlingual website, dis'ble th' switch language button.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableLanguageSwitchingButton< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide breadcrumbs 'n th' header an' only show th' current plank title< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableBreadcrumb< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set t' true, hide t'ble o' contents menu 'n th' header o' all planks< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableToc< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
2023-01-24 22:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set t' false, board th' MathJax module on every plank regardless if a MathJax shortcode be present< / span >
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableMathJax< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Specifies th' remote locat'n o' th' MathJax js< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMathJaxURL< / span > < span class = "p" > =< / span > < span class = "s2" > " https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Initializat'n parameter fer MathJax, see MathJax documentat'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mathJaxInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " {}" < / span >
2023-01-24 22:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set t' false, board th' Merrrmaid module on every plank regardless if a Merrrmaid shortcode or Merrrmaid codefence be present< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableMermaid< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Specifies th' remote locat'n o' th' Merrrmaid js< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customMermaidURL< / span > < span class = "p" > =< / span > < span class = "s2" > " https://unpkg.com/mermaid/dist/mermaid.min.js" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Initializat'n parameter fer Merrrmaid, see Merrrmaid documentat'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" theme\" : \" default\" }" < / span >
2023-01-24 22:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set t' false, board th' Swagger module on every plank regardless if a Swagger shortcode be present< / span >
2022-04-11 20:29:11 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableSwagger< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Specifies th' remote locat'n o' th' RapiDoc js< / span >
2022-07-03 11:31:55 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > customSwaggerURL< / span > < span class = "p" > =< / span > < span class = "s2" > " https://unpkg.com/rapidoc/dist/rapidoc-min.js" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Initializat'n parameter fer Swagger, see RapiDoc documentat'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > swaggerInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" theme\" : \" light\" }" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide Next an' Previous plank buttons normally displayed full height beside rrrambl'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableNextPrev< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Order sections 'n menu by " weight" or " title" . Default t' " weight" ;< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # this can be overridden 'n th' planks frontmatter< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > ordersectionsby< / span > < span class = "p" > =< / span > < span class = "s2" > " weight" < / span >
2023-02-04 21:34:28 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Change default color scheme wit' a variant one. Eg. can be " auto" , " red" , " blue" , " green" or an array like [ " blue" , " green" ].< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > themeVariant< / span > < span class = "p" > =< / span > < span class = "s2" > " auto" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Change th' title separator. Default t' " ::" .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > titleSeparator< / span > < span class = "p" > =< / span > < span class = "s2" > " -" < / span >
2022-10-05 23:10:59 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set t' true, th' menu 'n th' sidebar will be displayed 'n a collaps'ble tree view. Although th' functionality works wit' old browsers (IE11), th' display o' th' expander ay'cons be limited t' modern browsers< / span >
2022-04-03 10:12:47 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
2022-06-12 17:25:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If a single plank can contain rrrambl'n 'n multiple languages, add those here< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > additionalContentLanguage< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " en" < / span > < span class = "p" > ]< / span >
2022-11-05 23:35:48 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set t' true, no index.html will be appended t' prettyURLs; this will cause planks not< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # t' be serv'ble from th' file system< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableExplicitIndexURLs< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
2022-12-23 11:24:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # For external links ye can define how they be opened 'n yer browser; this sett'n will only be applied t' th' rrrambl'n area but not th' shortcut menu< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > externalLinkTarget< / span > < span class = "p" > =< / span > < span class = "s2" > " _blank" < / span >
2022-11-01 23:17:10 +00:00
< / span > < / span > < / code > < / pre > < / div > < h2 id = "serving-your-page-from-a-subfolder" > Serv'n yer plank from a subfolder< / h2 >
2022-11-05 23:35:48 +00:00
< p > If yer ship be served from a subfolder, eg. < code > https://example.com/mysite/< / code > , ye have t' set th' follow'n lines t' yer < code > config.toml< / code > < / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > baseURL< / span > < span class = "p" > =< / span > < span class = "s2" > " https://example.com/mysite/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > canonifyURLs< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
2022-11-05 23:35:48 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > relativeURLs< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
2022-12-23 11:24:54 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > Without < code > canonifyURLs=true< / code > URLs 'n sublemental planks (like < code > sitemap.xml< / code > , < code > rss.xml< / code > ) will be generated falsly while yer HTML files will still work. See < a href = "https://github.com/gohugoio/hugo/issues/5226" target = "_blank" > https://github.com/gohugoio/hugo/issues/5226< / a > .< / p >
2022-11-01 23:17:10 +00:00
< h2 id = "serving-your-page-from-the-filesystem" > Serv'n yer plank from th' filesystem< / h2 >
< p > If ye want yer plank served from th' filesystem by us'n URLs start'n wit' < code > file://< / code > you’ ll need th' follow'n configurat'n 'n yer < code > config.toml< / code > :< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > relativeURLs< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
2022-11-05 23:35:48 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > Th' theme will append an additional < code > index.html< / code > t' all branch bundle links by default t' make th' plank be serv'ble from th' file system. If ye don’ t care about th' file system an' only serve yer plank via a webserver ye can also generate th' links without this change by add'n this t' yer < code > config.toml< / code > < / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableExplicitIndexURLs< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-11-01 23:17:10 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-12-16 17:42:17 +00:00
< p > If ye want t' use th' search feature from th' file system us'n an older installat'n o' th' theme make sure t' change yer outputformat fer th' homepage from th' now deprecated < code > JSON< / code > t' < code > SEARCH< / code > < a href = "#activate-search" > as seen below< / a > .< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-11-01 23:17:10 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "activate-search" > Activate search< / h2 >
2022-11-01 23:17:10 +00:00
< p > If not already present, add th' follow'n lines 'n th' same < code > config.toml< / code > file.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > outputs< / span > < span class = "p" > ]< / span >
2022-11-01 23:17:10 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > home< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " SEARCH" < / span > < span class = "p" > ]< / span >
2023-01-30 17:00:33 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > This will generate a search index file at th' root o' yer public folder ready t' be consumed by th' Lunr search library. Avast that th' < code > SEARCH< / code > outputformat was named < code > JSON< / code > 'n previous releases but was implemented differently. Although < code > JSON< / code > still works, it be now deprecated.< / p >
2022-11-17 21:13:11 +00:00
< h3 id = "activate-dedicated-search-page" > Activate dedicated search plank< / h3 >
< p > Ye can add a dedicated search plank fer yer plank by add'n th' < code > SEARCHPAGE< / code > outputformat t' yer home plank by add'n th' follow'n lines 'n yer < code > config.toml< / code > file.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > outputs< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > home< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " SEARCH" < / span > < span class = "p" > ,< / span > < span class = "s2" > " SEARCHPAGE" < / span > < span class = "p" > ]< / span >
< / span > < / span > < / code > < / pre > < / div > < p > Ye can access this plank by either click'n on th' magnifier glass or by typ'n some search term an' press'n < code > ENTER< / code > inside o' th' menu’ s search box .< / p >
< p >
2023-02-10 23:05:55 +00:00
< a href = "#image-a8e31fd4716ae28181b4994d187cc42c" class = "lightbox-link" >
2022-11-17 21:13:11 +00:00
< img src = "../basics/configuration/search_page.png?&width=60pc" alt = "Screenshot o' th' dedicated search page" style = "height: auto; width: 60pc;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-a8e31fd4716ae28181b4994d187cc42c" >
2023-02-04 15:22:06 +00:00
< img src = "../basics/configuration/search_page.png?&width=60pc" alt = "Screenshot o' th' dedicated search page" class = "lightbox-image" loading = "lazy" >
2022-11-17 21:13:11 +00:00
< / a > < / p >
2022-04-02 13:30:16 +00:00
< h2 id = "activate-print-support" > Activate print support< / h2 >
< p > Ye can activate print support t' add th' capability t' print whole chapters or even th' complete ship. Just add th' < code > PRINT< / code > output format t' yer home, section an' plank 'n yer < code > config.toml< / code > as seen below:< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > outputs< / span > < span class = "p" > ]< / span >
2022-11-01 23:17:10 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > home< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " PRINT" < / span > < span class = "p" > ,< / span > < span class = "s2" > " SEARCH" < / span > < span class = "p" > ]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " PRINT" < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > plank< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " HTML" < / span > < span class = "p" > ,< / span > < span class = "s2" > " RSS" < / span > < span class = "p" > ,< / span > < span class = "s2" > " PRINT" < / span > < span class = "p" > ]< / span >
< / span > < / span > < / code > < / pre > < / div > < p > This will add a little printer ay'con 'n th' top bar. It will switch th' plank t' print preview when clicked. Ye can then send this plank t' th' printer by us'n yer browser’ s usual print functionality.< / p >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > Th' result'n URL will not be < a href = "https://gohugo.io/templates/output-formats/#configure-output-formats" target = "_blank" > configured ugly< / a > 'n terms o' < a href = "https://gohugo.io/content-management/urls/#ugly-urls" target = "_blank" > Hugo’ s URL handl'n< / a > even if you’ ve set < code > uglyURLs=true< / code > 'n yer < code > config.toml< / code > . This be due t' th' fact that fer one mime type only one suffix can be configured.< / p >
2022-08-23 19:10:03 +00:00
< p > Nevertheless, if you’ re unhappy wit' th' result'n URLs ye can manually redefine < code > outputFormats.PRINT< / code > 'n yer own < code > config.toml< / code > t' yer lik'n.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-07-02 12:20:53 +00:00
< h2 id = "mathjax" > MathJax< / h2 >
2022-12-16 17:42:17 +00:00
< p > Th' MathJax configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See < a href = "../shortcodes/math/" > Math< / a > fer additional documentat'n.< / p >
2022-07-02 12:20:53 +00:00
< h3 id = "math-example" > Example< / h3 >
< p > MathJax be globally disabled. By default it won’ t be boarded by any plank.< / p >
< p > On plank “ Physics” ye coded some JavaScript fer a dynamic formulae. Ye can set th' MathJax parameters locally t' board mathJax on this plank.< / p >
< p > Ye also can dis'ble MathJax fer specific planks while globally enabled.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "mermaid" > Merrrmaid< / h2 >
2022-12-16 17:42:17 +00:00
< p > Th' Merrrmaid configurat'n parameters can also be set on a specific plank. In this case, th' global parameter would be overwritten by th' local one. See < a href = "../shortcodes/mermaid/" > Merrrmaid< / a > fer additional documentat'n.< / p >
2022-07-02 12:20:53 +00:00
< h3 id = "mermaid-example" > Example< / h3 >
< p > Merrrmaid be globally disabled. By default it won’ t be boarded by any plank.< / p >
< p > On plank “ Architecture” ye coded some JavaScript t' dynamically generate a class diagram. Ye can set th' Merrrmaid parameters locally t' board mermaid on this plank.< / p >
2022-04-02 13:30:16 +00:00
< p > Ye also can dis'ble Merrrmaid fer specific planks while globally enabled.< / p >
< h2 id = "home-button-configuration" > Home Button Configurat'n< / h2 >
< p > If th' < code > disableLandingPageButton< / code > opt'n be set t' < code > false< / code > , a Home button will appear
on th' left menu. It be an alternative fer click'n on th' logo. T' edit th'
appearance, ye will have t' configure two parameters fer th' defined languages:< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > Languages< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ...< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageName< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-home' > < /i> Home" < / 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 class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ...< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageName< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-home' > < /i> Arrr! Homme" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ...< / span >
< / span > < / span > < / code > < / pre > < / div > < p > If those params be not configured fer a specific language, they will get their
default values:< / p >
2022-06-23 12:10:55 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageName< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-home' > < /i> Home" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > Th' home button be go'n t' look like this:< / p >
2022-11-05 23:35:48 +00:00
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-ab6c5f7d934140e728d954e60aafa821" class = "lightbox-link" >
2022-11-06 15:27:13 +00:00
< img src = "../basics/configuration/home_button_defaults.png?classes=shadow&width=300px" alt = "Default Home Button" class = "shadow" style = "height: auto; width: 300px;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-ab6c5f7d934140e728d954e60aafa821" >
2023-02-04 15:22:06 +00:00
< img src = "../basics/configuration/home_button_defaults.png?classes=shadow&width=300px" alt = "Default Home Button" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "customizatn" > Customizat' n< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-12-23 11:24:54 +00:00
< p > Th' Relearrrn theme has been built t' be as configur'ble as poss'ble by defin'n multiple < a href = "https://gohugo.io/templates/partials/" target = "_blank" > partials< / a > < / p >
< p > In < code > themes/hugo-theme-relearn/layouts/partials/< / code > , ye will find all th' partials defined fer this theme. If ye need t' overwrite someth'n, don’ t change th' code directly. Instead < a href = "https://gohugo.io/themes/customizing/" target = "_blank" > follow this plank< / a > . You’ d create a new partial 'n th' < code > layouts/partials< / code > folder o' yer local project. This partial will have th' priority.< / p >
2022-04-02 13:30:16 +00:00
< p > This theme defines th' follow'n partials :< / p >
< ul >
2022-12-16 17:42:17 +00:00
< li > < code > header.html< / code > : th' header o' th' plank. See < a href = "#output-formats" > output-formats< / a > < / li >
< li > < code > footer.html< / code > : th' footer o' th' plank. See < a href = "#output-formats" > output-formats< / a > < / li >
< li > < code > body.html< / code > : th' body o' th' plank. Th' body may contain o' one or many articles. See < a href = "#output-formats" > output-formats< / a > < / li >
< li > < code > article.html< / code > : th' output fer a single article, can contain elements around yer rrrambl'n. See < a href = "#output-formats" > output-formats< / a > < / li >
2022-04-02 13:30:16 +00:00
< li > < code > menu.html< / code > : left menu. < em > Not meant t' be overwritten< / em > < / li >
< li > < code > search.html< / code > : search box. < em > Not meant t' be overwritten< / em > < / li >
< li > < code > custom-header.html< / code > : custom headers 'n plank. Meant t' be overwritten when add'n CSS imports. Don’ t forget t' include < code > style< / code > HTML tag directive 'n yer file.< / li >
2022-10-31 14:06:51 +00:00
< li > < code > custom-footer.html< / code > : custom footer 'n plank. Meant t' be overwritten when add'n JavaScript. Don’ t forget t' include < code > javascript< / code > HTML tag directive 'n yer file.< / li >
2022-04-02 13:30:16 +00:00
< li > < code > favicon.html< / code > : th' favicon< / li >
2022-10-31 14:06:51 +00:00
< li > < code > heading-pre.html< / code > : side-wide configurat'n t' prepend t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’ s < code > headingPre< / code > sett'n into account.< / li >
< li > < code > heading-post.html< / code > : side-wide configurat'n t' append t' planks title head'ns. If ye override this, it be yer responsibility t' take th' page’ s < code > headingPost< / code > sett'n into account.< / li >
2022-04-02 13:30:16 +00:00
< li > < code > logo.html< / code > : th' logo, on top left hand corner< / li >
< li > < code > meta.html< / code > : HTML meta tags, if ye want t' change default behavior< / li >
2022-10-31 14:06:51 +00:00
< li > < code > menu-pre.html< / code > : side-wide configurat'n t' prepend t' menu items. If ye override this, it be yer responsibility t' take th' page’ s < code > menuPre< / code > sett'n into account.< / li >
< li > < code > menu-post.html< / code > : side-wide configurat'n t' append t' menu items. If ye override this, it be yer responsibility t' take th' page’ s < code > menuPost< / code > sett'n into account.< / li >
2022-04-02 13:30:16 +00:00
< li > < code > menu-footer.html< / code > : footer o' th' the left menu< / li >
< li > < code > toc.html< / code > : t'ble o' contents< / li >
2022-10-31 14:06:51 +00:00
< li > < code > rrrambl'n.html< / code > : th' rrrambl'n plank itself. This can be overridden if ye want t' display page’ s meta data above or below th' rrrambl'n.< / li >
2022-04-02 13:30:16 +00:00
< li > < code > content-footer< / code > : footer below th' rrrambl'n, has a default implementat'n but ye can overwrite it if ye don’ t like it.< / li >
< / ul >
< h2 id = "change-the-logo" > Change th' logo< / h2 >
< p > Create a new file 'n < code > layouts/partials/< / code > named < code > logo.html< / code > . Then write any HTML ye want.
Ye could use an < code > img< / code > HTML tag an' reference an image created under th' < em > static< / em > folder, or ye could paste a SVG definit'n!< / p >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > Th' size o' th' logo will adapt automatically< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< h2 id = "change-the-favicon" > Change th' favicon< / h2 >
2022-10-31 14:06:51 +00:00
< p > If yer favicon be a SVG, PNG or ICO, just drop off yer image 'n yer local < code > static/images/< / code > folder an' name it < code > favicon.svg< / code > , < code > favicon.png< / code > or < code > favicon.ico< / code > respectively.< / p >
2022-04-02 13:30:16 +00:00
< p > If no favicon file be found, th' theme will lookup th' alternative filename < code > logo< / code > 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.< / p >
< p > If ye need t' change this default behavior, create a new file 'n < code > layouts/partials/< / code > named < code > favicon.html< / code > . Then write someth'n like this:< / p >
2022-10-02 22:25:49 +00:00
< div class = "highlight" > < 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" > link< / span > < span class = "na" > rel< / span > < span class = "o" > =< / span > < span class = "s" > " icon" < / span > < span class = "na" > href< / span > < span class = "o" > =< / span > < span class = "s" > " /images/favicon.bmp" < / span > < span class = "na" > type< / span > < span class = "o" > =< / span > < span class = "s" > " image/bmp" < / span > < span class = "p" > > < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div > < h2 id = "theme-variant" > Change th' colors< / h2 >
< p > Th' Relearrrn theme lets ye choose between some predefined color variants 'n light or dark mode, but feel free t' add one yourself!< / p >
< p > Ye can preview th' shipped variants by chang'n them 'n th' variant selector at th' bottom o' th' menu.< / p >
< h3 id = "single-variant" > Single variant< / h3 >
< p > Set th' < code > themeVariant< / code > value wit' th' name o' yer theme file. That’ s it!< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > themeVariant< / span > < span class = "p" > =< / span > < span class = "s2" > " relearn-light" < / span >
2022-10-31 14:06:51 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > In th' above example yer theme file has t' be named < code > theme-relearn-light.css< / code > < / p >
2022-04-02 13:30:16 +00:00
< h3 id = "multiple-variants" > Multiple variants< / h3 >
2022-10-31 14:06:51 +00:00
< p > Ye can also set multiple variants. In this case, th' first variant be th' default chosen on first view an' a variant switch will be shown 'n th' menu footer.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Change default color scheme wit' a variant one.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > themeVariant< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " relearn-light" < / span > < span class = "p" > ,< / span > < span class = "s2" > " relearn-dark" < / span > < span class = "p" > ]< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle tip" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-lightbulb" > < / i > Smarrrt Arrrse< / div >
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > If ye want t' switch th' rules highlight'n theme together wit' yer color variant, generate a rules highlight'n stylesheet an' configure yer installat'n < a href = "https://gohugo.io/content-management/syntax-highlighting/" target = "_blank" > accord'n t' Hugo’ s documentat'n< / a > , an' < code > @import< / code > this stylesheet 'n yer color variant stylesheet. For an example, take a look into < code > theme-relearn-light.css< / code > an' < code > config.toml< / code > o' th' exampleSite.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-02-04 21:34:28 +00:00
< h3 id = "adjust-to-os-settings" > Adjust t' OS Sett'ns< / h3 >
< p > Ye can also cause th' ship t' adjust t' yer OS sett'ns fer light/dark mode. Just set th' < code > themeVariant< / code > t' < code > auto< / code > . That’ s it.< / p >
< p > If you’ ve set multiple variants, ye can drop < code > auto< / code > at any posit'n, but usually it makes sense t' set it 'n th' first posit'n an' make it th' default.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > themeVariant< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " auto" < / span > < span class = "p" > ,< / span > < span class = "s2" > " red" < / span > < span class = "p" > ]< / span >
< / span > < / span > < / code > < / pre > < / div > < p > If ye don’ t configure anyth'n else, th' theme will use < code > relearn-light< / code > fer light mode an' < code > relearn-dark< / code > fer dark mode.< / p >
< p > If ye don’ t like that, ye can set < code > themeVariantAuto< / code > . Th' first element be th' variant fer light mode, th' second fer dark mode< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > themeVariantAuto< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " learn" < / span > < span class = "p" > ,< / span > < span class = "s2" > " neon" < / span > < span class = "p" > ]< / span >
2023-02-04 22:38:52 +00:00
< / span > < / span > < / code > < / pre > < / div >
< 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 > This be not supported fer Internet Explorer 11, which still displays 'n th' < code > relearn-light< / code > variant.< / p >
< / div >
< / div >
< h3 id = "roll-your-own" > Roll yer own< / h3 >
2022-12-16 17:42:17 +00:00
< p > If ye be not happy wit' th' shipped variants ye can either copy an' rename one o' th' shipped files from < code > themes/hugo-theme-relearn/static/css< / code > t' < code > static/css< / code > , edit them afterwards t' yer lik'n 'n a text editor an' configure th' < code > themeVariant< / code > parameter 'n yer < code > config.toml< / code > or just use th' < a href = "../basics/generator/" > interactive variant generator< / a > .< / p >
2022-07-14 20:20:11 +00:00
< h3 id = "output-formats" > Output formats< / h3 >
2022-12-23 11:24:54 +00:00
< p > Certain parts o' th' theme can be changed fer support o' yer own < a href = "https://gohugo.io/templates/output-formats/" target = "_blank" > output formats< / a > . Eg. if ye define a new output format < code > PLAINTEXT< / code > 'n yer < code > config.toml< / code > , ye can add a file < code > layouts/partials/header.plaintext.html< / code > t' change th' way, th' plank header should look like fer that output format.< / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "stylesheet-generrratr" > Stylesheet generrrat' r< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This interactive tool may help ye t' generate yer own color variant stylesheet.< / p >
< p > T' get started, first select a color variant from th' variant switch that fits ye best as a start'n point.< / p >
< p > Th' graph be interactive an' reflect th' current colors. Ye can click on any o' th' colored boxes t' adjust th' respective color. Th' graph an' th' plank will update accordingly.< / p >
< p > Th' arrowed lines reflects how colors be inherited thru different parts o' th' theme if th' descendent isn’ t overwritten. If ye want t' delete a color an' let it inherit from its parent, just delete th' value from th' input field.< / p >
2022-10-31 14:06:51 +00:00
< p > T' better understand this select th' < code > neon< / code > variant an' modify th' different head'n colors. There, colors fer th' head'n < code > h2< / code > , < code > h3< / code > an' < code > h4< / code > be explicitly set. < code > h5< / code > be not set an' inherits its value from < code > h4< / code > . < code > h6< / code > be also not set an' inherits its value from < code > h5< / code > .< / p >
2022-04-02 13:30:16 +00:00
< p > Once you’ ve changed a color, th' variant switch will show a “ My custom variant” entry an' yer changes be stored 'n th' browser. Ye can change planks an' even close th' browser without los'n yer changes.< / p >
2022-11-05 12:11:21 +00:00
< p > Once ye be satisfied, ye can download th' new variants file an' copy it into yer site’ s < code > static/css< / code > directory. Afterwards ye have t' adjust th' < code > themeVariant< / code > parameter 'n yer < code > config.toml< / code > t' yer chosen file name.< / p >
< p > Eg. if yer new variants file be named < code > theme-my-custom-variant.css< / code > , ye have t' set < code > themeVariant='my-custom-variant'< / code > t' use it.< / p >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > This only works 'n modern browsers.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< h2 id = "variant-generator" > Variant generator< / h2 >
2022-07-02 12:20:53 +00:00
< p >
< span class = "btn cstyle secondary" >
2022-11-28 17:44:03 +00:00
< button onclick = "window.variants&&variants.getStylesheet();this.blur();" type = "button" >
2022-07-02 12:20:53 +00:00
< i class = "fa-fw fas fa-download" > < / i >
Download variant
2022-11-28 17:44:03 +00:00
< / button >
2022-07-02 12:20:53 +00:00
< / span >
< span class = "btn cstyle warning" >
2022-11-28 17:44:03 +00:00
< button onclick = "window.variants&&variants.resetVariant();this.blur();" type = "button" >
2022-07-02 12:20:53 +00:00
< i class = "fa-fw fas fa-trash" > < / i >
Reset variant
2022-11-28 17:44:03 +00:00
< / button >
2022-07-02 12:20:53 +00:00
< / span > < / p >
2022-10-07 18:46:19 +00:00
< div id = "vargenerator" class = "mermaid" style = "background-color: var(--INTERNAL-MAIN-TEXT-color);" > Graph< / div >
2022-07-02 12:20:53 +00:00
< p >
< span class = "btn cstyle secondary" >
2022-11-28 17:44:03 +00:00
< button onclick = "window.variants&&variants.getStylesheet();this.blur();" type = "button" >
2022-07-02 12:20:53 +00:00
< i class = "fa-fw fas fa-download" > < / i >
Download variant
2022-11-28 17:44:03 +00:00
< / button >
2022-07-02 12:20:53 +00:00
< / span >
< span class = "btn cstyle warning" >
2022-11-28 17:44:03 +00:00
< button onclick = "window.variants&&variants.resetVariant();this.blur();" type = "button" >
2022-07-02 12:20:53 +00:00
< i class = "fa-fw fas fa-trash" > < / i >
Reset variant
2022-11-28 17:44:03 +00:00
< / button >
2022-07-02 12:20:53 +00:00
< / span > < / p >
2022-04-02 13:30:16 +00:00
< script >
2022-11-28 17:44:03 +00:00
window.variants & & variants.generator( '#vargenerator' );
2022-04-02 13:30:16 +00:00
< / script >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "historrry" > Historrry< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-06-23 11:28:22 +00:00
< div class = "include hide-first-heading" >
2022-04-02 13:30:16 +00:00
< h1 id = "changelog" > Changelog< / h1 >
2023-02-07 17:09:51 +00:00
< h2 id = "5112-2023-02-07" > 5.11.2 (2023-02-07)< / h2 >
2023-02-06 05:42:55 +00:00
< h3 id = "fixes" > Fixes< / h3 >
< ul >
2023-02-07 17:09:51 +00:00
< li > [< strong > bug< / strong > ] tabs: nested tabs rrrambl'n be not displayed < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/468" target = "_blank" > #468< / a > < / li >
< / ul >
< hr >
< h2 id = "5111-2023-02-06" > 5.11.1 (2023-02-06)< / h2 >
< h3 id = "fixes-1" > Fixes< / h3 >
< ul >
2023-02-06 05:42:55 +00:00
< li > [< strong > bug< / strong > ] variant: include miss'n < code > theme-auto.css< / code > 'n distribut'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/467" target = "_blank" > #467< / a > < / li >
< / ul >
< hr >
2023-02-05 12:21:19 +00:00
< h2 id = "5110-2023-02-05" > 5.11.0 (2023-02-05)< / h2 >
< h3 id = "enhancements" > Enhancements< / h3 >
< ul >
< li > [< strong > feature< / strong > ] i18n: add Czech translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/455" target = "_blank" > #455< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] lightbox: switch t' CSS-only solut'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/451" target = "_blank" > #451< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] variant: add support fer < code > prefers-color-scheme< / code > < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/445" target = "_blank" > #445< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] expand: refactor fer a11y < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/339" target = "_blank" > #339< / a > < / li >
2023-02-06 05:42:55 +00:00
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] mermaid: make zoom configur'ble < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/144" target = "_blank" > #144< / a > < / li >
2023-02-05 12:21:19 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-2" > Fixes< / h3 >
2023-01-25 20:38:11 +00:00
< ul >
2023-02-05 12:21:19 +00:00
< li > [< strong > bug< / strong > ] swagger: avoid errors when us'n invalid rapi-doc fragment ids < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/465" target = "_blank" > #465< / a > < / li >
< li > [< strong > bug< / strong > ] search: fix oddities 'n keyboard handl'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/463" target = "_blank" > #463< / a > < / li >
< li > [< strong > bug< / strong > ] badge: fix text color fer IE11 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/462" target = "_blank" > #462< / a > < / li >
< li > [< strong > bug< / strong > ] mermaid: rerender graph if search term be present an' variant be switched < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/460" target = "_blank" > #460< / a > < / li >
< li > [< strong > bug< / strong > ] tags: show tag on planks when tag has space < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/459" target = "_blank" > #459< / a > < / li >
< li > [< strong > bug< / strong > ] edit: remove do'ble slash on root plank link < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/450" target = "_blank" > #450< / a > < / li >
< / ul >
< h3 id = "maintenance" > Maintenance< / h3 >
< ul >
< li > [< strong > task< / strong > ] build: add mov'n version tags < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/453" target = "_blank" > #453< / a > < / li >
< li > [< strong > task< / strong > ][< strong > change< / strong > ] theme: remove jQuery < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/452" target = "_blank" > #452< / a > < / li >
< li > [< strong > task< / strong > ] build: check fer release notes before release < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/448" target = "_blank" > #448< / a > < / li >
< / ul >
< hr >
< h2 id = "5102-2023-01-25" > 5.10.2 (2023-01-25)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-3" > Fixes< / h3 >
2023-02-05 12:21:19 +00:00
< ul >
2023-01-25 23:10:57 +00:00
< li > [< strong > bug< / strong > ] nav: fix breadcrumb fer huge installat'ns < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/446" target = "_blank" > #446< / a > < / li >
< / ul >
< hr >
< h2 id = "5101-2023-01-25" > 5.10.1 (2023-01-25)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-4" > Fixes< / h3 >
2023-01-25 23:10:57 +00:00
< ul >
2023-01-25 20:38:11 +00:00
< li > [< strong > bug< / strong > ] print: fix image links wit' relative path < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/444" target = "_blank" > #444< / a > < / li >
< / ul >
< hr >
2023-01-25 12:08:16 +00:00
< h2 id = "5100-2023-01-25" > 5.10.0 (2023-01-25)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-1" > Enhancements< / h3 >
2023-01-25 12:08:16 +00:00
< ul >
< li > [< strong > feature< / strong > ] shorrrtcodes: support fer accent color < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/440" target = "_blank" > #440< / a > < / li >
< li > [< strong > feature< / strong > ] shorrrtcodes: add color parameter whar' applic'ble < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/438" target = "_blank" > #438< / a > < / li >
< li > [< strong > feature< / strong > ] theme: announce translat'ns as alternate links < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/422" target = "_blank" > #422< / a > < / li >
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-5" > Fixes< / h3 >
2022-12-30 00:13:43 +00:00
< ul >
2023-01-25 12:08:16 +00:00
< li > [< strong > bug< / strong > ] nav: fix breadcrumbs fer deeply nested sections < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/442" target = "_blank" > #442< / a > < / li >
< li > [< strong > bug< / strong > ] theme: improve whitespac'n 'n tables < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/441" target = "_blank" > #441< / a > < / li >
< / ul >
< hr >
< h2 id = "594-2023-01-23" > 5.9.4 (2023-01-23)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-6" > Fixes< / h3 >
2023-01-25 12:08:16 +00:00
< ul >
2023-01-23 12:49:43 +00:00
< li > [< strong > bug< / strong > ] variant: fix search ay'con an' text color < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/437" target = "_blank" > #437< / a > < / li >
< / ul >
< hr >
< h2 id = "593-2023-01-22" > 5.9.3 (2023-01-22)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-7" > Fixes< / h3 >
2023-01-23 12:49:43 +00:00
< ul >
2023-01-22 22:49:01 +00:00
< li > [< strong > bug< / strong > ] nav: fix left/right navigat'n fer horizontal scroll'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/435" target = "_blank" > #435< / a > < / li >
< li > [< strong > bug< / strong > ] theme: allow planks on top level < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/434" target = "_blank" > #434< / a > < / li >
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-1" > Maintenance< / h3 >
2023-01-22 22:49:01 +00:00
< ul >
< li > [< strong > task< / strong > ] build: switch t' wildcard version o' act'ns < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/428" target = "_blank" > #428< / a > < / li >
< / ul >
< hr >
< h2 id = "592-2022-12-30" > 5.9.2 (2022-12-30)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-8" > Fixes< / h3 >
2023-01-22 22:49:01 +00:00
< ul >
2022-12-30 00:13:43 +00:00
< li > [< strong > bug< / strong > ] search: apply dependency scripts fer Hindi an' Japanese < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/427" target = "_blank" > #427< / a > < / li >
< / ul >
< hr >
2022-12-23 11:28:12 +00:00
< h2 id = "591-2022-12-23" > 5.9.1 (2022-12-23)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-2" > Enhancements< / h3 >
2022-12-23 02:26:08 +00:00
< ul >
2022-12-23 11:28:12 +00:00
< li > [< strong > feature< / strong > ] theme: make external link target configur'ble < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/426" target = "_blank" > #426< / a > < / li >
< / ul >
< hr >
< h2 id = "590-2022-12-23" > 5.9.0 (2022-12-23)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-3" > Enhancements< / h3 >
2022-12-23 11:28:12 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] theme: open external links 'n separate tab < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/419" target = "_blank" > #419< / a > < / li >
< li > [< strong > feature< / strong > ] theme: make it a Cap'n Hugo module < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/417" target = "_blank" > #417< / a > < / li >
2022-12-23 02:26:08 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-9" > Fixes< / h3 >
2022-12-11 22:22:02 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ][< strong > change< / strong > ] attachments: fix incorrect links fer defaultContentLanguageInSubdir=true < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/425" target = "_blank" > #425< / a > < / li >
2022-12-23 02:26:08 +00:00
< / ul >
< hr >
< h2 id = "581-2022-12-11" > 5.8.1 (2022-12-11)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-10" > Fixes< / h3 >
2022-12-23 02:26:08 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix alias fer home plank if defaultContentLanguageInSubdir=true < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/414" target = "_blank" > #414< / a > < / li >
2022-12-11 22:22:02 +00:00
< / ul >
< hr >
2022-12-08 10:19:04 +00:00
< h2 id = "580-2022-12-08" > 5.8.0 (2022-12-08)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-4" > Enhancements< / h3 >
2022-11-23 22:02:52 +00:00
< ul >
2023-01-24 22:59:44 +00:00
< li > [< strong > feature< / strong > ] ay'con: add new shortcode < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/412" target = "_blank" > #412< / a > < / li >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] theme: style an' document markdown extensions < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/411" target = "_blank" > #411< / a > < / li >
2023-01-24 22:59:44 +00:00
< li > [< strong > feature< / strong > ] badge: add new shortcode < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/410" target = "_blank" > #410< / a > < / li >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] theme: add accent color < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/409" target = "_blank" > #409< / a > < / li >
2022-11-23 22:02:52 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-11" > Fixes< / h3 >
2022-11-19 01:04:14 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix spac'n fer tag flyout 'n FF < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/413" target = "_blank" > #413< / a > < / li >
2022-12-08 10:19:04 +00:00
< / ul >
< hr >
< h2 id = "570-2022-11-29" > 5.7.0 (2022-11-29)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-5" > Enhancements< / h3 >
2022-12-08 10:19:04 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] button: refactor fer a11y < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/372" target = "_blank" > #372< / a > < / li >
2022-12-08 10:19:04 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-12" > Fixes< / h3 >
2022-12-08 10:19:04 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] search: don’ t freeze browser on long search terms < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/408" target = "_blank" > #408< / a > < / li >
< li > [< strong > bug< / strong > ] search: fix searchbox placeholder color 'n FF an' IE < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/405" target = "_blank" > #405< / a > < / li >
< li > [< strong > bug< / strong > ][< strong > change< / strong > ] i18n: rename Korean translat'n from country t' lang code < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/404" target = "_blank" > #404< / a > < / li >
2022-11-29 19:41:45 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-2" > Maintenance< / h3 >
2022-11-29 19:41:45 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] search: update lunr languages t' 1.10.0 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/403" target = "_blank" > #403< / a > < / li >
2022-11-29 19:41:45 +00:00
< / ul >
< hr >
< h2 id = "566-2022-11-23" > 5.6.6 (2022-11-23)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-6" > Enhancements< / h3 >
2022-11-29 19:41:45 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] search: make build an' js forgiv'n against config errors < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/400" target = "_blank" > #400< / a > < / li >
2022-11-29 19:41:45 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-13" > Fixes< / h3 >
2022-11-29 19:41:45 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] variant: minor color adjustments < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/402" target = "_blank" > #402< / a > < / li >
< li > [< strong > bug< / strong > ] variant: fix generator fer use o' neon < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/401" target = "_blank" > #401< / a > < / li >
2022-11-23 22:02:52 +00:00
< / ul >
< hr >
< h2 id = "565-2022-11-19" > 5.6.5 (2022-11-19)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-14" > Fixes< / h3 >
2022-11-23 22:02:52 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] menu: relax usage o' background color < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/399" target = "_blank" > #399< / a > < / li >
2022-11-19 19:31:17 +00:00
< / ul >
< hr >
< h2 id = "564-2022-11-19" > 5.6.4 (2022-11-19)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-15" > Fixes< / h3 >
2022-11-19 19:31:17 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: make alias planks us'ble by file:// protocol < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/398" target = "_blank" > #398< / a > < / li >
2022-11-19 17:03:47 +00:00
< / ul >
< hr >
< h2 id = "563-2022-11-19" > 5.6.3 (2022-11-19)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-16" > Fixes< / h3 >
2022-11-19 17:03:47 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: be compat'ble wit' Cap'n Hugo > = 0.95.0 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/397" target = "_blank" > #397< / a > < / li >
2022-11-19 12:42:40 +00:00
< / ul >
< hr >
< h2 id = "562-2022-11-19" > 5.6.2 (2022-11-19)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-17" > Fixes< / h3 >
2022-11-19 12:42:40 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: build breaks sites without “ output” section 'n config < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/396" target = "_blank" > #396< / a > < / li >
2022-11-19 11:33:00 +00:00
< / ul >
< hr >
< h2 id = "561-2022-11-19" > 5.6.1 (2022-11-19)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-18" > Fixes< / h3 >
2022-11-19 11:33:00 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix image distort'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/395" target = "_blank" > #395< / a > < / li >
2022-11-19 01:04:14 +00:00
< / ul >
< hr >
2022-11-18 23:30:00 +00:00
< h2 id = "560-2022-11-18" > 5.6.0 (2022-11-18)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-7" > Enhancements< / h3 >
2022-11-18 23:30:00 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] toc: improve keyboard handl'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/390" target = "_blank" > #390< / a > < / li >
< li > [< strong > feature< / strong > ] search: improve keyboard handl'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/387" target = "_blank" > #387< / a > < / li >
< li > [< strong > feature< / strong > ] search: add dedicated search plank < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/386" target = "_blank" > #386< / a > < / li >
< li > [< strong > feature< / strong > ] theme: make creat'n o' generator meta tag configur'ble < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/383" target = "_blank" > #383< / a > < / li >
< li > [< strong > feature< / strong > ] theme: increase build performance < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/380" target = "_blank" > #380< / a > < / li >
2022-11-18 23:30:00 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-19" > Fixes< / h3 >
2022-11-07 19:59:33 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] mermaid: avoid lead'n whitespace < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/394" target = "_blank" > #394< / a > < / li >
< li > [< strong > bug< / strong > ] theme: fix build errors when referenc'n SVGs 'n markdown < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/393" target = "_blank" > #393< / a > < / li >
< li > [< strong > bug< / strong > ] variant: avoid neon t' leak into IE11 fallback < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/392" target = "_blank" > #392< / a > < / li >
< li > [< strong > bug< / strong > ] theme: fix urls fer file:// protocol 'n sitemap < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/385" target = "_blank" > #385< / a > < / li >
< li > [< strong > bug< / strong > ] theme: add id t' h1 elements < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/384" target = "_blank" > #384< / a > < / li >
< li > [< strong > bug< / strong > ] rss: fix display o' hidden subpages < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/382" target = "_blank" > #382< / a > < / li >
< li > [< strong > bug< / strong > ] nav: fix key navigat'n when press'n wrong modifiers < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/379" target = "_blank" > #379< / a > < / li >
2022-11-18 23:30:00 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-3" > Maintenance< / h3 >
2022-11-18 23:30:00 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] mermaid: update t' version 9.2.2 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/391" target = "_blank" > #391< / a > < / li >
2022-11-18 23:30:00 +00:00
< / ul >
< hr >
< h2 id = "553-2022-11-10" > 5.5.3 (2022-11-10)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-20" > Fixes< / h3 >
2022-11-18 23:30:00 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] tags: fix non-latin tag display on planks < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/378" target = "_blank" > #378< / a > < / li >
2022-11-10 09:09:19 +00:00
< / ul >
< hr >
< h2 id = "552-2022-11-08" > 5.5.2 (2022-11-08)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-21" > Fixes< / h3 >
2022-11-10 09:09:19 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix typo 'n 404.html < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/376" target = "_blank" > #376< / a > < / li >
< li > [< strong > bug< / strong > ] theme: allow menu items an' children t' be served by file:// protocol < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/375" target = "_blank" > #375< / a > < / li >
2022-11-08 22:47:34 +00:00
< / ul >
< hr >
< h2 id = "551-2022-11-07" > 5.5.1 (2022-11-07)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-22" > Fixes< / h3 >
2022-11-08 22:47:34 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix overflow'n issue wit' anchors an' tooltips < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/364" target = "_blank" > #364< / a > < / li >
2022-11-07 19:59:33 +00:00
< / ul >
< hr >
2022-11-06 16:04:11 +00:00
< h2 id = "550-2022-11-06" > 5.5.0 (2022-11-06)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-8" > Enhancements< / h3 >
2022-11-05 23:42:17 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] theme: opt'mize plank board fer images < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/304" target = "_blank" > #304< / a > < / li >
2022-11-05 23:42:17 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-23" > Fixes< / h3 >
2022-11-05 23:42:17 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix context 'n render hooks < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/373" target = "_blank" > #373< / a > < / li >
< li > [< strong > bug< / strong > ] print: make canonical URL absolute < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/371" target = "_blank" > #371< / a > < / li >
2022-11-06 16:04:11 +00:00
< / ul >
< hr >
< h2 id = "543-2022-11-05" > 5.4.3 (2022-11-05)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-9" > Enhancements< / h3 >
2022-11-06 16:04:11 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] history: refactor fer a11y < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/341" target = "_blank" > #341< / a > < / li >
2022-11-06 16:04:11 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-24" > Fixes< / h3 >
2022-11-06 16:04:11 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix multilang links when ship served from subdirectory < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/370" target = "_blank" > #370< / a > < / li >
2022-11-05 23:42:17 +00:00
< / ul >
< hr >
2022-11-05 12:45:43 +00:00
< h2 id = "542-2022-11-05" > 5.4.2 (2022-11-05)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-4" > Maintenance< / h3 >
2022-11-05 12:45:43 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] build: change set-output t' env vars < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/348" target = "_blank" > #348< / a > < / li >
2022-11-05 12:45:43 +00:00
< / ul >
< hr >
2022-11-05 12:44:07 +00:00
< h2 id = "541-2022-11-05" > 5.4.1 (2022-11-05)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-25" > Fixes< / h3 >
2022-11-05 12:44:07 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] mermaid: fix Gantt chart width < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/365" target = "_blank" > #365< / a > < / li >
2022-11-05 12:44:07 +00:00
< / ul >
< hr >
2022-11-01 23:33:58 +00:00
< h2 id = "540-2022-11-01" > 5.4.0 (2022-11-01)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-10" > Enhancements< / h3 >
2022-11-01 23:33:58 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] math: allow pass'n o' parameters wit' codefence rules < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/363" target = "_blank" > #363< / a > < / li >
< li > [< strong > feature< / strong > ] i18n: add Finnish translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/361" target = "_blank" > #361< / a > < / li >
< li > [< strong > feature< / strong > ] mermaid: allow pass'n o' parameters wit' codefence rules < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/360" target = "_blank" > #360< / a > < / li >
< li > [< strong > feature< / strong > ] i18n: support RTL < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/357" target = "_blank" > #357< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] button: add opt'n fer target < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/351" target = "_blank" > #351< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] theme: allow t' be served by file:// protocol < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/349" target = "_blank" > #349< / a > < / li >
2022-11-01 23:33:58 +00:00
< / ul >
< hr >
2022-10-09 11:39:21 +00:00
< h2 id = "533-2022-10-09" > 5.3.3 (2022-10-09)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-26" > Fixes< / h3 >
2022-10-08 20:57:29 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] archetypes: fix frontmatter on home.md template < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/346" target = "_blank" > #346< / a > < / li >
2022-10-09 11:39:21 +00:00
< / ul >
< hr >
< h2 id = "532-2022-10-08" > 5.3.2 (2022-10-08)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-27" > Fixes< / h3 >
2022-10-09 11:39:21 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] nav: change defunct keyboard shortcuts < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/344" target = "_blank" > #344< / a > < / li >
2022-10-08 20:57:29 +00:00
< / ul >
< hr >
2022-10-08 19:47:58 +00:00
< h2 id = "531-2022-10-08" > 5.3.1 (2022-10-08)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-11" > Enhancements< / h3 >
2022-10-07 20:27:01 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] i18n: update Spanish translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/343" target = "_blank" > #343< / a > < / li >
< li > [< strong > feature< / strong > ] theme: opt'n t' align images < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/327" target = "_blank" > #327< / a > < / li >
2022-10-08 19:47:58 +00:00
< / ul >
< hr >
< h2 id = "530-2022-10-07" > 5.3.0 (2022-10-07)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-12" > Enhancements< / h3 >
2022-10-08 19:47:58 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] expander: improve whitespace between label an' rrrambl'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/338" target = "_blank" > #338< / a > < / li >
< li > [< strong > feature< / strong > ] swagger: improve print version < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/333" target = "_blank" > #333< / a > < / li >
2022-10-07 20:27:01 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-28" > Fixes< / h3 >
2022-08-23 19:11:57 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] print: fix links o' subsections < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/340" target = "_blank" > #340< / a > < / li >
< li > [< strong > bug< / strong > ] theme: remove W3C validator errors < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/337" target = "_blank" > #337< / a > < / li >
< li > [< strong > bug< / strong > ] children: remove unused < code > plank< / code > parameter from docs < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/336" target = "_blank" > #336< / a > < / li >
< li > [< strong > bug< / strong > ] print: remove menu placeholder 'n Firefox < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/335" target = "_blank" > #335< / a > < / li >
< li > [< strong > bug< / strong > ] swagger: fix download button overflow < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/334" target = "_blank" > #334< / a > < / li >
< li > [< strong > bug< / strong > ][< strong > change< / strong > ] a11y: remove WCAG errors whar' applic'ble < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/307" target = "_blank" > #307< / a > < / li >
2022-10-07 20:27:01 +00:00
< / ul >
< hr >
< h2 id = "524-2022-10-02" > 5.2.4 (2022-10-02)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-29" > Fixes< / h3 >
2022-10-07 20:27:01 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: remove HTML5 validator errors < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/329" target = "_blank" > #329< / a > < / li >
2022-10-02 22:34:07 +00:00
< / ul >
< hr >
< h2 id = "523-2022-09-12" > 5.2.3 (2022-09-12)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-30" > Fixes< / h3 >
2022-10-02 22:34:07 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] print: chapter planks overwrite font-size < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/328" target = "_blank" > #328< / a > < / li >
2022-09-12 18:01:22 +00:00
< / ul >
< hr >
< h2 id = "522-2022-08-23" > 5.2.2 (2022-08-23)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-31" > Fixes< / h3 >
2022-09-12 18:01:22 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] print: fix urls fer uglyURLs=true < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/322" target = "_blank" > #322< / a > < / li >
2022-08-23 19:11:57 +00:00
< / ul >
< hr >
2022-08-05 21:56:05 +00:00
< h2 id = "521-2022-08-05" > 5.2.1 (2022-08-05)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-13" > Enhancements< / h3 >
2022-08-03 17:34:11 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] i18n: improve Japanese translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/318" target = "_blank" > #318< / a > < / li >
2022-08-03 17:34:11 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-32" > Fixes< / h3 >
2022-07-15 20:25:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] nav: prev/next ignores ordersectionby < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/320" target = "_blank" > #320< / a > < / li >
2022-08-05 21:56:05 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-5" > Maintenance< / h3 >
2022-08-05 21:56:05 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] task: bump Cap'n Hugo minimum requirement t' 0.95 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/319" target = "_blank" > #319< / a > < / li >
2022-08-05 21:56:05 +00:00
< / ul >
< hr >
< h2 id = "520-2022-08-03" > 5.2.0 (2022-08-03)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-14" > Enhancements< / h3 >
2022-08-05 21:56:05 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] menu: expand collapsed menus if search term be found 'n submenus < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/312" target = "_blank" > #312< / a > < / li >
2022-08-05 21:56:05 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-33" > Fixes< / h3 >
2022-08-05 21:56:05 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] print: switch mermaid an' swagger style before print < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/316" target = "_blank" > #316< / a > < / li >
< li > [< strong > bug< / strong > ] theme: fix chapter margins on big screens < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/315" target = "_blank" > #315< / a > < / li >
2022-08-03 17:34:11 +00:00
< / ul >
< hr >
< h2 id = "512-2022-07-18" > 5.1.2 (2022-07-18)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-34" > Fixes< / h3 >
2022-08-03 17:34:11 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] print: reset mermaid theme t' light < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/313" target = "_blank" > #313< / a > < / li >
< li > [< strong > bug< / strong > ] mermaid: header be show'n up 'n FF < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/311" target = "_blank" > #311< / a > < / li >
2022-07-18 06:59:19 +00:00
< / ul >
< hr >
< h2 id = "511-2022-07-15" > 5.1.1 (2022-07-15)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-35" > Fixes< / h3 >
2022-07-18 06:59:19 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] tags: don’ t count tags if plank be hidden < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/310" target = "_blank" > #310< / a > < / li >
2022-07-15 20:25:16 +00:00
< / ul >
< hr >
2022-07-15 13:20:59 +00:00
< h2 id = "510-2022-07-15" > 5.1.0 (2022-07-15)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-15" > Enhancements< / h3 >
2022-07-15 13:20:59 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] print: make print url deterministic < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/309" target = "_blank" > #309< / a > < / li >
< li > [< strong > feature< / strong > ] theme: allow overrid'n partials fer output formats < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/308" target = "_blank" > #308< / a > < / li >
2022-07-15 13:20:59 +00:00
< / ul >
< hr >
2022-07-07 22:51:32 +00:00
< h2 id = "503-2022-07-07" > 5.0.3 (2022-07-07)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-36" > Fixes< / h3 >
2022-07-07 22:33:08 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] ie11: no styles aft rework o' archetypes < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/306" target = "_blank" > #306< / a > < / li >
2022-07-07 22:51:32 +00:00
< / ul >
< hr >
< h2 id = "502-2022-07-07" > 5.0.2 (2022-07-07)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-37" > Fixes< / h3 >
2022-07-07 22:51:32 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: board CSS if JS be disabled < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/305" target = "_blank" > #305< / a > < / li >
2022-07-07 22:33:08 +00:00
< / ul >
< hr >
2022-07-07 22:18:31 +00:00
< h2 id = "501-2022-07-07" > 5.0.1 (2022-07-07)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-16" > Enhancements< / h3 >
2022-07-05 22:38:03 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ][< strong > break'n< / strong > ] theme: opt'mize load'n o' js an' css < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/303" target = "_blank" > #303< / a > < / li >
2022-07-07 22:18:31 +00:00
< / ul >
< hr >
< h2 id = "500-2022-07-05" > 5.0.0 (2022-07-05)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-17" > Enhancements< / h3 >
2022-07-07 22:18:31 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] archetypes: modularize render'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/300" target = "_blank" > #300< / a > < / li >
< li > [< strong > feature< / strong > ] history: don’ t reload plank when history gets cleared < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/299" target = "_blank" > #299< / a > < / li >
< li > [< strong > feature< / strong > ] menu: replace expander by fontawesome chevrons < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/296" target = "_blank" > #296< / a > < / li >
< li > [< strong > feature< / strong > ] theme: align rrrambl'n wit' topbar ay'con limits < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/290" target = "_blank" > #290< / a > < / li >
< li > [< strong > feature< / strong > ] button: allow fer empty href < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/288" target = "_blank" > #288< / a > < / li >
< li > [< strong > feature< / strong > ] i18n: make Simplified Chinese th' standard language fer th' < code > zn< / code > code < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/287" target = "_blank" > #287< / a > < / li >
< li > [< strong > feature< / strong > ] clipboard: move head styles t' stylesheet < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/286" target = "_blank" > #286< / a > < / li >
< li > [< strong > feature< / strong > ] math: add mathjax render'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/235" target = "_blank" > #235< / a > < / li >
< li > [< strong > feature< / strong > ] theme: allow fer plank head'n modificat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/139" target = "_blank" > #139< / a > < / li >
2022-07-05 22:38:03 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-38" > Fixes< / h3 >
2022-06-23 11:26:33 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] favicon: fix URL if ship resides 'n subfolder < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/302" target = "_blank" > #302< / a > < / li >
< li > [< strong > bug< / strong > ] code: show copy-to-clipboard marker fer blocklevel code < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/298" target = "_blank" > #298< / a > < / li >
< li > [< strong > bug< / strong > ] menu: make active expander vis'ble on hover < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/297" target = "_blank" > #297< / a > < / li >
< li > [< strong > bug< / strong > ] print: dis'ble arrow navigat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/294" target = "_blank" > #294< / a > < / li >
< li > [< strong > bug< / strong > ] print: add miss'n plank break aft index or section < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/292" target = "_blank" > #292< / a > < / li >
< li > [< strong > bug< / strong > ] theme: use more space on wide screens < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/291" target = "_blank" > #291< / a > < / li >
< li > [< strong > bug< / strong > ] theme: fix size o' chapter head'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/289" target = "_blank" > #289< / a > < / li >
2022-07-05 22:38:03 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-6" > Maintenance< / h3 >
2022-07-05 22:38:03 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] chore: update RapiDoc 9.3.3 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/301" target = "_blank" > #301< / a > < / li >
< li > [< strong > task< / strong > ] chore: update Merrrmaid 9.1.3 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/293" target = "_blank" > #293< / a > < / li >
2022-07-05 22:38:03 +00:00
< / ul >
< hr >
< h2 id = "425-2022-06-23" > 4.2.5 (2022-06-23)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-39" > Fixes< / h3 >
2022-07-05 22:38:03 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] swagger: javascript code does not board 'n documentat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/285" target = "_blank" > #285< / a > < / li >
< li > [< strong > bug< / strong > ] children: descript'ns not work'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/284" target = "_blank" > #284< / a > < / li >
< li > [< strong > bug< / strong > ] print: fix empty plank fer shortcut links < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/283" target = "_blank" > #283< / a > < / li >
2022-06-23 18:07:22 +00:00
< / ul >
< hr >
< h2 id = "424-2022-06-23" > 4.2.4 (2022-06-23)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-40" > Fixes< / h3 >
2022-06-23 18:07:22 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix url fer logo an' home button < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/282" target = "_blank" > #282< / a > < / li >
2022-06-23 12:13:44 +00:00
< / ul >
< hr >
< h2 id = "423-2022-06-23" > 4.2.3 (2022-06-23)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-41" > Fixes< / h3 >
2022-06-23 12:13:44 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ][< strong > break'n< / strong > ] include: second parameter be ignored < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/281" target = "_blank" > #281< / a > < / li >
2022-06-23 11:26:33 +00:00
< / ul >
< hr >
2022-06-23 11:44:26 +00:00
< h2 id = "422-2022-06-23" > 4.2.2 (2022-06-23)< / h2 >
2022-06-23 11:36:37 +00:00
< p > < em > No changelog fer this release.< / em > < / p >
< hr >
2022-06-23 11:30:18 +00:00
< h2 id = "421-2022-06-23" > 4.2.1 (2022-06-23)< / h2 >
< p > < em > No changelog fer this release.< / em > < / p >
< hr >
2022-06-23 10:38:02 +00:00
< h2 id = "420-2022-06-23" > 4.2.0 (2022-06-23)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-18" > Enhancements< / h3 >
2022-06-23 10:38:02 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] tabs: don’ t change tab select'n if panel does not contain item < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/279" target = "_blank" > #279< / a > < / li >
< li > [< strong > feature< / strong > ] shorrrtcodes: convert t' partials < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/277" target = "_blank" > #277< / a > < / li >
2022-06-23 10:38:02 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-42" > Fixes< / h3 >
2022-06-18 16:51:47 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] swagger: avoid builtin syntax-highlightn'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/280" target = "_blank" > #280< / a > < / li >
< li > [< strong > bug< / strong > ] search: fix console message fer miss'n lunr translat'ns < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/278" target = "_blank" > #278< / a > < / li >
< li > [< strong > bug< / strong > ] tabs: fix wrapp'n when hav'n many tabs < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/272" target = "_blank" > #272< / a > < / li >
2022-06-23 10:38:02 +00:00
< / ul >
< hr >
< h2 id = "411-2022-06-18" > 4.1.1 (2022-06-18)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-43" > Fixes< / h3 >
2022-06-23 10:38:02 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] notice: fix layout when rrrambl'n starts wit' head'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/275" target = "_blank" > #275< / a > < / li >
2022-06-18 16:51:47 +00:00
< / ul >
< hr >
2022-06-12 17:27:49 +00:00
< h2 id = "410-2022-06-12" > 4.1.0 (2022-06-12)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-19" > Enhancements< / h3 >
2022-06-12 17:27:49 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] i18n: support multilang rrrambl'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/271" target = "_blank" > #271< / a > < / li >
2022-06-12 17:27:49 +00:00
< / ul >
< hr >
2022-06-12 13:28:03 +00:00
< h2 id = "405-2022-06-12" > 4.0.5 (2022-06-12)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-44" > Fixes< / h3 >
2022-06-12 13:28:03 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] i18n: Vietnamese language wit' wrong lang code < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/270" target = "_blank" > #270< / a > < / li >
< li > [< strong > bug< / strong > ] i18n: fix search fer non western languages < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/269" target = "_blank" > #269< / a > < / li >
2022-06-12 13:28:03 +00:00
< / ul >
< hr >
2022-06-07 18:38:50 +00:00
< h2 id = "404-2022-06-07" > 4.0.4 (2022-06-07)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-20" > Enhancements< / h3 >
2022-06-05 22:51:46 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] theme: improve keyboard navigat'n fer scroll'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/268" target = "_blank" > #268< / a > < / li >
2022-06-07 18:38:50 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-45" > Fixes< / h3 >
2022-06-07 18:38:50 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] swagger: adjust font-size fer method buttons < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/267" target = "_blank" > #267< / a > < / li >
< li > [< strong > bug< / strong > ] menu: hide expander when only hidden subpages < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/264" target = "_blank" > #264< / a > < / li >
< li > [< strong > bug< / strong > ] theme: make compat'ble wit' Cap'n Hugo 0.100.0 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/263" target = "_blank" > #263< / a > < / li >
2022-06-07 18:38:50 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-7" > Maintenance< / h3 >
2022-06-07 18:38:50 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] swagger: update rapidoc t' 9.3.2 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/266" target = "_blank" > #266< / a > < / li >
< li > [< strong > task< / strong > ] mermaid: update t' 9.1.1 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/265" target = "_blank" > #265< / a > < / li >
2022-06-07 18:38:50 +00:00
< / ul >
< hr >
< h2 id = "403-2022-06-05" > 4.0.3 (2022-06-05)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-21" > Enhancements< / h3 >
2022-06-07 18:38:50 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] toc: add scrollbar < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/262" target = "_blank" > #262< / a > < / li >
2022-06-05 22:51:46 +00:00
< / ul >
< hr >
2022-06-05 22:04:07 +00:00
< h2 id = "402-2022-06-05" > 4.0.2 (2022-06-05)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-46" > Fixes< / h3 >
2022-06-05 21:59:56 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: let browser scroll plank on CTRL+f < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/242" target = "_blank" > #242< / a > < / li >
2022-06-05 21:59:56 +00:00
< / ul >
< hr >
2022-06-05 22:04:07 +00:00
< h2 id = "401-2022-06-05" > 4.0.1 (2022-06-05)< / h2 >
< p > < em > No changelog fer this release.< / em > < / p >
< hr >
2022-06-05 17:35:48 +00:00
< h2 id = "400-2022-06-05" > 4.0.0 (2022-06-05)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-22" > Enhancements< / h3 >
2022-06-05 17:35:48 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] shorrrtcodes: add named parameter if miss'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/260" target = "_blank" > #260< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > break'n< / strong > ] theme: remove – MAIN-ANCHOR-color from stylesheet < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/256" target = "_blank" > #256< / a > < / li >
< li > [< strong > feature< / strong > ] i18n: add Italian translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/254" target = "_blank" > #254< / a > < / li >
< li > [< strong > feature< / strong > ] attachments: support fer brand colors < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/252" target = "_blank" > #252< / a > < / li >
< li > [< strong > feature< / strong > ] notice: support fer brand colors < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/251" target = "_blank" > #251< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > break'n< / strong > ] config: remove custom_css < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/248" target = "_blank" > #248< / a > < / li >
< li > [< strong > feature< / strong > ] theme: use proper file extension fer page-meta.go < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/246" target = "_blank" > #246< / a > < / li >
< li > [< strong > feature< / strong > ] variant: add support fer brand color variables < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/239" target = "_blank" > #239< / a > < / li >
< li > [< strong > feature< / strong > ] i18n: add Polish translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/237" target = "_blank" > #237< / a > < / li >
2022-06-05 17:35:48 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-47" > Fixes< / h3 >
2022-04-03 19:40:25 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] shorrrtcodes: accept boolean parameters if given as str'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/261" target = "_blank" > #261< / a > < / li >
< li > [< strong > bug< / strong > ] print: adjust button an' tab size < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/259" target = "_blank" > #259< / a > < / li >
< li > [< strong > bug< / strong > ] print: show Merrrmaid if requested 'n frontmatter < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/255" target = "_blank" > #255< / a > < / li >
< li > [< strong > bug< / strong > ] theme: adjust thin scrollbar slider < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/244" target = "_blank" > #244< / a > < / li >
< li > [< strong > bug< / strong > ] mobile: fix broken scrollbar < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/243" target = "_blank" > #243< / a > < / li >
< li > [< strong > bug< / strong > ] theme: fix display o' tooltip fer head'n anchor < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/241" target = "_blank" > #241< / a > < / li >
2022-06-05 17:35:48 +00:00
< / ul >
< hr >
< h2 id = "341-2022-04-03" > 3.4.1 (2022-04-03)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-48" > Fixes< / h3 >
2022-06-05 17:35:48 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix IE11 incompatibilities < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/234" target = "_blank" > #234< / a > < / li >
2022-04-03 19:40:25 +00:00
< / ul >
< hr >
2022-04-03 11:05:43 +00:00
< h2 id = "340-2022-04-03" > 3.4.0 (2022-04-03)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-23" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] i18n: add Traditional Chinese translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/233" target = "_blank" > #233< / a > < / li >
< li > [< strong > feature< / strong > ] menu: expand/collapse menu items without navigat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/231" target = "_blank" > #231< / a > < / li >
< li > [< strong > feature< / strong > ] print: add opt'n t' print whole chapter < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/230" target = "_blank" > #230< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > break'n< / strong > ] theme: apply user supplied rrrambl'n footer below rrrambl'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/229" target = "_blank" > #229< / a > < / li >
2022-04-03 11:05:43 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-49" > Fixes< / h3 >
2022-04-03 11:05:43 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: scroll t' head'n on initial board < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/232" target = "_blank" > #232< / a > < / li >
2022-04-03 11:05:43 +00:00
< / ul >
< hr >
< h2 id = "330-2022-03-28" > 3.3.0 (2022-03-28)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-24" > Enhancements< / h3 >
2022-04-03 11:05:43 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] theme: add CSS font variables < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/227" target = "_blank" > #227< / a > < / li >
< li > [< strong > feature< / strong > ] swagger: add support fer oas/swagger documentat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/226" target = "_blank" > #226< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-50" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] variant: make variant switch work on slow networks < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/228" target = "_blank" > #228< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "321-2022-03-25" > 3.2.1 (2022-03-25)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-51" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] print: fix minor inconsistencies < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/225" target = "_blank" > #225< / a > < / li >
< li > [< strong > bug< / strong > ] print: show more than just th' title plank < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/224" target = "_blank" > #224< / a > < / li >
< li > [< strong > bug< / strong > ] theme: align rrrambl'n scrollbar t' th' right on big screens < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/223" target = "_blank" > #223< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "320-2022-03-19" > 3.2.0 (2022-03-19)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-25" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] mermaid: support differ'n themes fer color variant switch < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/219" target = "_blank" > #219< / a > < / li >
< li > [< strong > feature< / strong > ] mermaid: board javascript on demand < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/218" target = "_blank" > #218< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-8" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] mermaid: update t' 8.14.0 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/220" target = "_blank" > #220< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "311-2022-03-16" > 3.1.1 (2022-03-16)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-26" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] i18n: add Korean translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/217" target = "_blank" > #217< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "310-2022-03-15" > 3.1.0 (2022-03-15)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-27" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] notice: add ay'con parameter < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/212" target = "_blank" > #212< / a > < / li >
< li > [< strong > feature< / strong > ] mobile: remove breadcrumb ellipsis < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/211" target = "_blank" > #211< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-52" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: make storage o' multiple Cap'n Hugo sites on same server distinct < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/214" target = "_blank" > #214< / a > < / li >
< li > [< strong > bug< / strong > ] variant: switch breadcrumb color 'n Chrome < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/213" target = "_blank" > #213< / a > < / li >
< li > [< strong > bug< / strong > ] mobile: improve behavior o' sidebar menu < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/210" target = "_blank" > #210< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "304-2022-02-24" > 3.0.4 (2022-02-24)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-28" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] theme: improve font load'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/201" target = "_blank" > #201< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] variant: fix inconsistent color vari'ble nam'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/200" target = "_blank" > #200< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-53" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] variant: fix occasional fail when resett'n generator < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/208" target = "_blank" > #208< / a > < / li >
< li > [< strong > bug< / strong > ] docs: don’ t move header on logo hover 'n IE11 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/207" target = "_blank" > #207< / a > < / li >
< li > [< strong > bug< / strong > ] variant: avoid flash o' menu header when non default variant be active < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/206" target = "_blank" > #206< / a > < / li >
< li > [< strong > bug< / strong > ] theme: fix wrong HTML clos'n tag order 'n chapters < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/205" target = "_blank" > #205< / a > < / li >
< li > [< strong > bug< / strong > ] theme: adjust breadcrumb an' title fer empty home plank titles < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/202" target = "_blank" > #202< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "303-2022-02-23" > 3.0.3 (2022-02-23)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-29" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] tags: show tag count 'n taxonomy list < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/195" target = "_blank" > #195< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-54" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: remove Cap'n Hugo build warning if plank be not file based < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/197" target = "_blank" > #197< / a > < / li >
< li > [< strong > bug< / strong > ] tags: adhere t' titleSeparator < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/196" target = "_blank" > #196< / a > < / li >
< li > [< strong > bug< / strong > ] theme: hide footer divider an' variant selector 'n IE11 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/194" target = "_blank" > #194< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "302-2022-02-23" > 3.0.2 (2022-02-23)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-30" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] tags: sort by name < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/193" target = "_blank" > #193< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "301-2022-02-23" > 3.0.1 (2022-02-23)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-31" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] children: set containerstyle automatically accord'n t' style < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/192" target = "_blank" > #192< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-55" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: revert fontawsome t' version 5 fer IE11 compat < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/191" target = "_blank" > #191< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "300-2022-02-22" > 3.0.0 (2022-02-22)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-32" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] variant: build a variant generator < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/188" target = "_blank" > #188< / a > < / li >
< li > [< strong > feature< / strong > ] nav: only show toc if th' plank has head'ns < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/182" target = "_blank" > #182< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > break'n< / strong > ] theme: change default colors t' Relearrrn defaults < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/181" target = "_blank" > #181< / a > < / li >
< li > [< strong > feature< / strong > ] variant: add a variant selector < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/178" target = "_blank" > #178< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > break'n< / strong > ] menu: rework footer UX < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/177" target = "_blank" > #177< / a > < / li >
< li > [< strong > feature< / strong > ] theme: support fer dark mode < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/175" target = "_blank" > #175< / a > < / li >
< li > [< strong > feature< / strong > ] docs: use light rules highlightn'n theme < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/174" target = "_blank" > #174< / a > < / li >
< li > [< strong > feature< / strong > ] notice: tweak dull colors < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/173" target = "_blank" > #173< / a > < / li >
< li > [< strong > feature< / strong > ] theme: rework header UX < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/151" target = "_blank" > #151< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-56" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] search: remove additional X 'n filled out search box 'n IE11 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/190" target = "_blank" > #190< / a > < / li >
< li > [< strong > bug< / strong > ] clipboard: localize tooltips < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/186" target = "_blank" > #186< / a > < / li >
< li > [< strong > bug< / strong > ] print: hide sidebar on Mac < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/183" target = "_blank" > #183< / a > < / li >
< li > [< strong > bug< / strong > ] menu: fix scrollbar height < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/180" target = "_blank" > #180< / a > < / li >
< li > [< strong > bug< / strong > ][< strong > change< / strong > ] search: fix color change fer ay'cons on hover < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/176" target = "_blank" > #176< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "296-2022-02-07" > 2.9.6 (2022-02-07)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-57" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] menu: remove debug output < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/171" target = "_blank" > #171< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "295-2022-02-07" > 2.9.5 (2022-02-07)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-58" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] menu: let arrow navigat'n respect ordersectionsby configurat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/170" target = "_blank" > #170< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "294-2022-02-06" > 2.9.4 (2022-02-06)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-59" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] exampleSite: fix links 'n official documentat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/168" target = "_blank" > #168< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "293-2022-02-06" > 2.9.3 (2022-02-06)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-60" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] menu: invalid URL when th' shortcut be an internal link < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/163" target = "_blank" > #163< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "292-2021-11-26" > 2.9.2 (2021-11-26)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-33" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] theme: add theme version info t' head < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/158" target = "_blank" > #158< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-61" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix select'n o' *.ico files as favicons < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/160" target = "_blank" > #160< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "291-2021-11-22" > 2.9.1 (2021-11-22)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-62" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] menu: fix significantly low performance fer collect'n o' meta info < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/157" target = "_blank" > #157< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "290-2021-11-19" > 2.9.0 (2021-11-19)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-63" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ][< strong > break'n< / strong > ] relref: fix inconsistent behavior < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/156" target = "_blank" > #156< / a > < / li >
< li > [< strong > bug< / strong > ] search: make dropdown stick t' search field when scroll'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/155" target = "_blank" > #155< / a > < / li >
< li > [< strong > bug< / strong > ] menu: align long text properly < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/154" target = "_blank" > #154< / a > < / li >
< li > [< strong > bug< / strong > ] copyToClipBoard: add miss'n right border fer inline code if < code > disableInlineCopyToClipBoard=true< / code > < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/153" target = "_blank" > #153< / a > < / li >
< li > [< strong > bug< / strong > ] menu: show hidden sibl'n planks reliably < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/152" target = "_blank" > #152< / a > < / li >
< li > [< strong > bug< / strong > ] menu: br'n active item 'n sight fer large menus < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/149" target = "_blank" > #149< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "283-2021-11-09" > 2.8.3 (2021-11-09)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-64" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] mermaid: let zoom reset t' initial size < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/145" target = "_blank" > #145< / a > < / li >
< li > [< strong > bug< / strong > ] mermaid: remove whitespace from big graphs < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/143" target = "_blank" > #143< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "282-2021-11-08" > 2.8.2 (2021-11-08)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-65" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] mermaid: always board javascript t' avoid break if code fences be used < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/142" target = "_blank" > #142< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "281-2021-11-04" > 2.8.1 (2021-11-04)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-66" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] search: don’ t break JS 'n multilang setup if search be disabled < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/140" target = "_blank" > #140< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "280-2021-11-03" > 2.8.0 (2021-11-03)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-34" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] toc: make disableTOC globally avail'ble via config.toml < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/133" target = "_blank" > #133< / a > < / li >
< li > [< strong > feature< / strong > ] mermaid: only board javascript if necessary < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/95" target = "_blank" > #95< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] theme: switch font < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/83" target = "_blank" > #83< / a > < / li >
< li > [< strong > feature< / strong > ] theme: make favicon configur'ble < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/2" target = "_blank" > #2< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-67" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] mermaid: assert that window.mermaid be actually mermaid < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/136" target = "_blank" > #136< / a > < / li >
< li > [< strong > bug< / strong > ] menu: remove usage o' Hugos UniqueID < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/131" target = "_blank" > #131< / a > < / li >
2023-01-24 22:59:44 +00:00
< li > [< strong > bug< / strong > ] theme: reduce margin fer children shortcode < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/130" target = "_blank" > #130< / a > < / li >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: left-align h3 'n chapters < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/129" target = "_blank" > #129< / a > < / li >
< li > [< strong > bug< / strong > ] theme: align copy link t' clipboard < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/128" target = "_blank" > #128< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "270-2021-10-24" > 2.7.0 (2021-10-24)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-35" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] notice: support custom titles < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/124" target = "_blank" > #124< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "260-2021-10-21" > 2.6.0 (2021-10-21)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-68" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: generate correct links if theme served from subdirectory < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/120" target = "_blank" > #120< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "251-2021-10-12" > 2.5.1 (2021-10-12)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-69" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] security: fix XSS fer malicioius image URLs < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/117" target = "_blank" > #117< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "250-2021-10-08" > 2.5.0 (2021-10-08)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-36" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] rules highlight: provide default colors fer unknown languages < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/113" target = "_blank" > #113< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-70" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] security: fix XSS fer malicioius URLs < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/114" target = "_blank" > #114< / a > < / li >
< li > [< strong > bug< / strong > ] menu: write correct local shortcut links < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/112" target = "_blank" > #112< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "241-2021-10-07" > 2.4.1 (2021-10-07)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-71" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: remove runtime styles from print < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/111" target = "_blank" > #111< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "240-2021-10-07" > 2.4.0 (2021-10-07)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-37" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] lang: add vietnamese translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/109" target = "_blank" > #109< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] theme: simplify stylesheet fer color variants < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/107" target = "_blank" > #107< / a > < / li >
< li > [< strong > feature< / strong > ] hidden planks: remove from RSS feed, JSON, taxonomy etc < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/102" target = "_blank" > #102< / a > < / li >
< li > [< strong > feature< / strong > ] theme: announce alternative rrrambl'n 'n header < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/101" target = "_blank" > #101< / a > < / li >
< li > [< strong > feature< / strong > ] menu: frontmatter opt'n t' change sort predicate < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/98" target = "_blank" > #98< / a > < / li >
< li > [< strong > feature< / strong > ] menu: add default sett'n fer menu expansion < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/97" target = "_blank" > #97< / a > < / li >
< li > [< strong > feature< / strong > ] theme: improve print style < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/93" target = "_blank" > #93< / a > < / li >
< li > [< strong > feature< / strong > ] theme: improve style < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/92" target = "_blank" > #92< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-72" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] include: don’ t generate additional HTML if file should be displayed “ as is” < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/110" target = "_blank" > #110< / a > < / li >
< li > [< strong > bug< / strong > ] attachments: fix broken links if multilang config be used < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/105" target = "_blank" > #105< / a > < / li >
< li > [< strong > bug< / strong > ] theme: fix sticky header t' remove horizontal scrollbar < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/82" target = "_blank" > #82< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-9" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] chore: update fontawesome < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/94" target = "_blank" > #94< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "232-2021-09-20" > 2.3.2 (2021-09-20)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-73" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] docs: rename history pirate translat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/91" target = "_blank" > #91< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "231-2021-09-20" > 2.3.1 (2021-09-20)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-74" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] docs: rename english pirate translat'n t' avoid crash on render'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/90" target = "_blank" > #90< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "230-2021-09-13" > 2.3.0 (2021-09-13)< / h2 >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-75" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix usage o' section element < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/88" target = "_blank" > #88< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-10" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] theme: ensure IE11 compatiblity < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/89" target = "_blank" > #89< / a > < / li >
< li > [< strong > task< / strong > ] docs: Arrr! showcase multilang featurrre < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/87" target = "_blank" > #87< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "220-2021-09-09" > 2.2.0 (2021-09-09)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-38" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] sitemap: hide hidden planks from sitemap an' SEO index'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/85" target = "_blank" > #85< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-76" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] theme: fix showVisitedLinks 'n case Cap'n Hugo be configured t' modify relative URLs < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/86" target = "_blank" > #86< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-11" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] theme: switch from data-vocabulary t' schema < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/84" target = "_blank" > #84< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "210-2021-09-07" > 2.1.0 (2021-09-07)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-39" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] search: open expand if it contains search term < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/80" target = "_blank" > #80< / a > < / li >
< li > [< strong > feature< / strong > ] menu: scroll active item into view < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/79" target = "_blank" > #79< / a > < / li >
< li > [< strong > feature< / strong > ] search: dis'ble search 'n hidden planks < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/76" target = "_blank" > #76< / a > < / li >
< li > [< strong > feature< / strong > ] search: improve readablility o' index.json < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/75" target = "_blank" > #75< / a > < / li >
< li > [< strong > feature< / strong > ] search: increase performance < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/74" target = "_blank" > #74< / a > < / li >
< li > [< strong > feature< / strong > ] search: improve search context preview < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/73" target = "_blank" > #73< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-77" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ][< strong > change< / strong > ] search: hide non-site rrrambl'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/81" target = "_blank" > #81< / a > < / li >
< li > [< strong > bug< / strong > ] menu: always hide hidden sub planks < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/77" target = "_blank" > #77< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "200-2021-08-28" > 2.0.0 (2021-08-28)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-40" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] tabs: enhance styl'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/65" target = "_blank" > #65< / a > < / li >
< li > [< strong > feature< / strong > ] theme: improve readability < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/64" target = "_blank" > #64< / a > < / li >
< li > [< strong > feature< / strong > ] menu: show hidden planks if accessed directly < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/60" target = "_blank" > #60< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] theme: treat planks without title as hidden < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/59" target = "_blank" > #59< / a > < / li >
< li > [< strong > feature< / strong > ] search: show search results if field gains focus < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/58" target = "_blank" > #58< / a > < / li >
< li > [< strong > feature< / strong > ] theme: add partial templates fer pre/post menu entries < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/56" target = "_blank" > #56< / a > < / li >
< li > [< strong > feature< / strong > ] theme: make chapter archetype more read'ble < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/55" target = "_blank" > #55< / a > < / li >
< li > [< strong > feature< / strong > ] children: add parameter fer container style < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/53" target = "_blank" > #53< / a > < / li >
< li > [< strong > feature< / strong > ] theme: make rrrambl'n a template < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/50" target = "_blank" > #50< / a > < / li >
< li > [< strong > feature< / strong > ] menu: control menu expansion wit' alwaysopen parameter < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/49" target = "_blank" > #49< / a > < / li >
2023-01-24 22:59:44 +00:00
< li > [< strong > feature< / strong > ] include: new shortcode t' include other files < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/43" target = "_blank" > #43< / a > < / li >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] theme: adjust print styles < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/35" target = "_blank" > #35< / a > < / li >
< li > [< strong > feature< / strong > ][< strong > change< / strong > ] code highlighter: switch t' standard hugo highlighter < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/32" target = "_blank" > #32< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-78" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ][< strong > change< / strong > ] arrow-nav: default sort'n ignores ordersectionsby < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/63" target = "_blank" > #63< / a > < / li >
< li > [< strong > bug< / strong > ][< strong > change< / strong > ] children: default sort'n ignores ordersectionsby < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/62" target = "_blank" > #62< / a > < / li >
< li > [< strong > bug< / strong > ][< strong > change< / strong > ] arrow-nav: fix broken links on (and below) hidden planks < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/61" target = "_blank" > #61< / a > < / li >
< li > [< strong > bug< / strong > ] theme: remove superfluous singular taxonomy from taxonomy title < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/46" target = "_blank" > #46< / a > < / li >
< li > [< strong > bug< / strong > ][< strong > change< / strong > ] theme: miss'n – MENU-HOME-LINK-HOVER-color 'n documentat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/45" target = "_blank" > #45< / a > < / li >
< li > [< strong > bug< / strong > ] theme: fix home link when base URL has some path < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/44" target = "_blank" > #44< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-12" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] docs: include changelog 'n exampleSite < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/33" target = "_blank" > #33< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "120-2021-07-26" > 1.2.0 (2021-07-26)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-41" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] theme: adjust copy-to-clipboard < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/29" target = "_blank" > #29< / a > < / li >
< li > [< strong > feature< / strong > ] attachments: adjust style between notice boxes an' attachments < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/28" target = "_blank" > #28< / a > < / li >
< li > [< strong > feature< / strong > ] theme: adjust blockquote contrast < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/27" target = "_blank" > #27< / a > < / li >
< li > [< strong > feature< / strong > ] expand: add opt'n t' open on plank board < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/25" target = "_blank" > #25< / a > < / li >
< li > [< strong > feature< / strong > ] expand: rework styl'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/24" target = "_blank" > #24< / a > < / li >
< li > [< strong > feature< / strong > ] attachments: sort output < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/23" target = "_blank" > #23< / a > < / li >
< li > [< strong > feature< / strong > ] notice: make restyl'n o' notice boxes more robust < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/20" target = "_blank" > #20< / a > < / li >
< li > [< strong > feature< / strong > ] notice: fix contrast issues < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/19" target = "_blank" > #19< / a > < / li >
< li > [< strong > feature< / strong > ] notice: align box colors t' common standards < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/18" target = "_blank" > #18< / a > < / li >
< li > [< strong > feature< / strong > ] notice: use distinct ay'cons fer notice box type < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/17" target = "_blank" > #17< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-79" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] attachments: support i18n fer attachment size < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/21" target = "_blank" > #21< / a > < / li >
< li > [< strong > bug< / strong > ] notice: support i18n fer box labels < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/16" target = "_blank" > #16< / a > < / li >
< li > [< strong > bug< / strong > ] notice: support multiple blocks 'n one box < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/15" target = "_blank" > #15< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-13" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] dependency: upgrade jquery t' 3.6.0 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/30" target = "_blank" > #30< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "111-2021-07-04" > 1.1.1 (2021-07-04)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-14" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] theme: prepare fer new hugo theme registrat'n < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/13" target = "_blank" > #13< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "110-2021-07-02" > 1.1.0 (2021-07-02)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "enhancements-42" > Enhancements< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > feature< / strong > ] mermaid: expose opt'ns 'n config.toml < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/4" target = "_blank" > #4< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-07 17:09:51 +00:00
< h3 id = "fixes-80" > Fixes< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > bug< / strong > ] mermaid: config opt'n fer CDN url not used < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/12" target = "_blank" > #12< / a > < / li >
< li > [< strong > bug< / strong > ] mermaid: only highlight text 'n HTML elements < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/10" target = "_blank" > #10< / a > < / li >
< li > [< strong > bug< / strong > ] mermaid: support pan & zoom fer graphs < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/9" target = "_blank" > #9< / a > < / li >
< li > [< strong > bug< / strong > ] mermaid: code fences not always rendered < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/6" target = "_blank" > #6< / a > < / li >
< li > [< strong > bug< / strong > ] mermaid: search term on board may bomb chart < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/5" target = "_blank" > #5< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-15" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] mermaid: update t' 8.10.2 < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/7" target = "_blank" > #7< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "101-2021-07-01" > 1.0.1 (2021-07-01)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-16" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] Prepare fer hugo showcase < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/3" target = "_blank" > #3< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< hr >
< h2 id = "100-2021-07-01" > 1.0.0 (2021-07-01)< / h2 >
2023-02-05 12:21:19 +00:00
< h3 id = "maintenance-17" > Maintenance< / h3 >
2022-04-02 13:30:16 +00:00
< ul >
2022-12-23 11:24:54 +00:00
< li > [< strong > task< / strong > ] Fork project < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/1" target = "_blank" > #1< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2022-06-23 11:25:28 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< / section >
2022-11-07 19:58:08 +00:00
< article class = "chapter" >
2022-07-05 22:16:52 +00:00
< div class = "article-subheading" > T' chapterrr 2< / div >
2022-11-13 21:34:47 +00:00
< h1 id = "rambln" > Rambl' n< / h1 >
2022-04-02 13:30:16 +00:00
< p > Find out how t' create an' org'nize yer rrrambl'n quickly an' intuitively.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
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 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "planks-orrrganizatn" > Planks orrrganizat' n< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > In < strong > Cap'n Hugo< / strong > , planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.< / p >
< h2 id = "folders" > Folders< / h2 >
2022-12-23 11:24:54 +00:00
< p > Org'nize yer ship like < a href = "https://gohugo.io/content/organization/" target = "_blank" > any other Cap'n Hugo project< / a > . Typically, ye will have a < em > rrrambl'n< / em > folder wit' all yer planks.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > rrrambl'n
< / span > < / span > < span class = "line" > < span class = "cl" > ├── level-one
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── level-two
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ ├── level-three
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ ├── level-four
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ │ ├── _index.md < -- /level-one/level-two/level-three/level-four
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ │ ├── page-4-a.md < -- /level-one/level-two/level-three/level-four/page-4-a
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ │ ├── page-4-b.md < -- /level-one/level-two/level-three/level-four/page-4-b
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ │ └── page-4-c.md < -- /level-one/level-two/level-three/level-four/page-4-c
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ ├── _index.md < -- /level-one/level-two/level-three
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ ├── page-3-a.md < -- /level-one/level-two/level-three/page-3-a
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ ├── page-3-b.md < -- /level-one/level-two/level-three/page-3-b
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ └── page-3-c.md < -- /level-one/level-two/level-three/page-3-c
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ ├── _index.md < -- /level-one/level-two
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ ├── page-2-a.md < -- /level-one/level-two/page-2-a
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ ├── page-2-b.md < -- /level-one/level-two/page-2-b
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ └── page-2-c.md < -- /level-one/level-two/page-2-c
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── _index.md < -- /level-one
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── page-1-a.md < -- /level-one/page-1-a
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── page-1-b.md < -- /level-one/page-1-b
< / span > < / span > < span class = "line" > < span class = "cl" > │ └── page-1-c.md < -- /level-one/page-1-c
< / span > < / span > < span class = "line" > < span class = "cl" > ├── _index.md < -- /
< / span > < / span > < span class = "line" > < span class = "cl" > └── page-top.md < -- /page-top
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > < code > _index.md< / code > be required 'n each folder, it’ < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< h2 id = "create-your-project" > Create yer project< / h2 >
2022-12-23 11:24:54 +00:00
< p > Th' follow'n steps be here t' help ye initialize yer new website. If ye don’ t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n < a href = "https://gohugo.io/overview/quickstart/" target = "_blank" > great documentat'n fer beginners< / a > .< / p >
2022-04-02 13:30:16 +00:00
< p > Cap'n Hugo provides a < code > new< / code > command t' create a new website.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new ship < new_project>
2022-12-16 17:42:17 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > Th' Relearrrn theme provides < a href = "../cont/archetypes/" > archetypes< / a > t' help ye create this kind o' planks.< / p >
2022-07-05 22:16:52 +00:00
< h2 id = "frontmatter-configuration" > Frontmatter Configurat'n< / h2 >
2022-12-23 11:24:54 +00:00
< p > Each Cap'n Hugo plank has t' define a < a href = "https://gohugo.io/content/front-matter/" target = "_blank" > frontmatter< / a > 'n < em > toml< / em > , < em > yaml< / em > or < em > json< / em > . This ship will use < em > toml< / em > 'n all cases.< / p >
2022-07-05 22:16:52 +00:00
< p > Th' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones:< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Avast: Toc be always disabled fer chapter planks< / 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 = "c" > # If set, this will be used fer th' page' s menu entry (instead o' th' `title` attribute)< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuTitle< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set, this will explicitly override common rules fer th' expand state o' a page' s menu entry< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set, this will explicitly override common rules fer th' sort'n order o' a page' s submenu entries< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > ordersectionsby< / span > < span class = "p" > =< / span > < span class = "s2" > " title" < / span >
2022-07-03 15:22:50 +00:00
< / 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 = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank head'n will be postfixed 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 = "s2" > " " < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank 'n menu will be prefixed by this HTML rrrambl'n< / span >
2022-07-03 15:22:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPre< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Th' title o' th' plank 'n menu will be postfixed by this HTML rrrambl'n< / span >
2022-07-03 15:22:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPost< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide a menu entry by sett'n this t' true< / 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 = "c" > # Display name o' this plank modifier. If set, it will be displayed 'n th' footer.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierDisplayName< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Email o' this plank modifier. If set wit' LastModifierDisplayName, it will be displayed 'n th' footer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierEmail< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < / code > < / pre > < / div > < h3 id = "add-icon-to-a-menu-entry" > Add ay'con t' a menu entry< / h3 >
2022-07-03 15:22:50 +00:00
< p > In th' plank frontmatter, add a < code > menuPre< / code > param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " GitHub repo" < / span >
2022-07-03 15:22:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPre< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fab fa-github' > < /i> " < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2022-11-05 23:35:48 +00:00
< / span > < / span > < / code > < / pre > < / div > < p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-cb57da0525536b7c17584aa9ea524388" class = "lightbox-link" >
2022-11-06 15:27:13 +00:00
< img src = "../cont/pages/frontmatter-icon.png?classes=shadow&width=300px" alt = "Title wit' icon" class = "shadow" style = "height: auto; width: 300px;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-cb57da0525536b7c17584aa9ea524388" >
2023-02-04 15:22:06 +00:00
< img src = "../cont/pages/frontmatter-icon.png?classes=shadow&width=300px" alt = "Title wit' icon" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-04-02 13:30:16 +00:00
< h3 id = "ordering-sibling-menupage-entries" > Order'n sibl'n menu/page entries< / h3 >
2022-12-23 11:24:54 +00:00
< p > Cap'n Hugo provides a < a href = "https://gohugo.io/content/ordering/" target = "_blank" > flex'ble way< / a > t' handle order fer yer planks.< / p >
2022-04-02 13:30:16 +00:00
< p > Th' simplest way be t' set < code > weight< / code > parameter t' a number.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " 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 >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < / code > < / pre > < / div > < h3 id = "using-a-custom-title-for-menu-entries" > Us'n a custom title fer menu entries< / h3 >
< p > By default, th' Relearrrn theme will use a page’ s < code > title< / code > attribute fer th' menu item (or < code > linkTitle< / code > if defined).< / p >
< p > But a page’ s title has t' be descriptive on its own while th' menu be a hierarchy.
We’ ve added th' < code > menuTitle< / code > parameter fer that purpose:< / p >
< p > For example (for a plank named < code > content/install/linux.md< / code > ):< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Install on Linux" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuTitle< / span > < span class = "p" > =< / span > < span class = "s2" > " Linux" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < / code > < / pre > < / div > < h3 id = "override-expand-state-rules-for-menu-entries" > Override expand state rules fer menu entries< / h3 >
< p > Ye can change how th' theme expands menu entries on th' side o' th' rrrambl'n wit' th' < code > alwaysopen< / code > sett'n on a per plank basis. 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' menu based on th' follow'n rules:< / p >
< ul >
< li > all parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns< / li >
< li > immediate children 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 >
2022-10-31 14:06:51 +00:00
< li > all vis'ble entries show their immediate children entries if < code > alwaysopen=true< / code > ; this proceeds recursively< / li >
2022-04-02 13:30:16 +00:00
< li > all remain'n entries be not shown< / li >
< / ul >
2023-01-24 22:59:44 +00:00
< p > Ye can see this feature 'n act'n on th' example plank fer < a href = "../shortcodes/children/" > children shortcode< / a > an' its children planks.< / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "arrrchetypes" > Arrrchetypes< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-12-23 11:24:54 +00:00
< p > Us'n th' command: < code > hugo new [relative new rrrambl'n path]< / code > , ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: < a href = "https://gohugo.io/content/archetypes/" target = "_blank" > archetypes< / a > . These be preconfigured skeleton planks wit' default frontmatter.< / p >
2022-07-05 22:16:52 +00:00
< p > Th' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.< / p >
< h2 id = "predefined-archetypes" > Predefined Archetypes< / 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 >
2022-11-05 23:35:48 +00:00
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-ca0521a6d7e917ee8bbe1d44ec064b43" class = "lightbox-link" >
2022-11-06 15:27:13 +00:00
< img src = "../cont/archetypes/pages-home.png?classes=shadow&width=60pc" alt = "Home page" class = "shadow" style = "height: auto; width: 60pc;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-ca0521a6d7e917ee8bbe1d44ec064b43" >
2023-02-04 15:22:06 +00:00
< img src = "../cont/archetypes/pages-home.png?classes=shadow&width=60pc" alt = "Home page" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-07-05 22:16:52 +00:00
< p > T' create a home plank, run th' follow'n command< / p >
< div class = "highlight" > < 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 > < p > This leads t' a file wit' th' follow'n rrrambl'n< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > +++
< / span > < / span > < span class = "line" > < span class = "cl" > archetype = " home"
< / span > < / span > < span class = "line" > < span class = "cl" > title = " {{ replace .Name " -" " " | title }}"
< / span > < / span > < span class = "line" > < span class = "cl" > +++
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-07-05 22:16:52 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Lorem Ipsum.
< / span > < / span > < / code > < / pre > < / div > < 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. Commonly, it contains a simple title an' a catch line t' define rrrambl'n that can be found below it.< / p >
2022-11-05 23:35:48 +00:00
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-f8fcff68698988776701a4916baf840f" class = "lightbox-link" >
2022-11-06 15:27:13 +00:00
< img src = "../cont/archetypes/pages-chapter.png?classes=shadow&width=60pc" alt = "Chapter page" class = "shadow" style = "height: auto; width: 60pc;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-f8fcff68698988776701a4916baf840f" >
2023-02-04 15:22:06 +00:00
< img src = "../cont/archetypes/pages-chapter.png?classes=shadow&width=60pc" alt = "Chapter page" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-07-05 22:16:52 +00:00
< p > T' create a chapter plank, run th' follow'n command< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind chapter < name> /_index.md
< / span > < / span > < / code > < / pre > < / div > < p > This leads t' a file wit' th' follow'n rrrambl'n< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > +++
< / span > < / span > < span class = "line" > < span class = "cl" > archetype = " chapter"
< / span > < / span > < span class = "line" > < span class = "cl" > title = " {{ replace .Name " -" " " | title }}"
< / span > < / span > < span class = "line" > < span class = "cl" > weight = X
< / span > < / span > < span class = "line" > < span class = "cl" > +++
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-07-05 22:16:52 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Lorem Ipsum.
< / span > < / span > < / code > < / pre > < / div > < p > Replace th' < code > X< / code > wit' a number. Because this number 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 level.< / p >
< h3 id = "archetypes-default" > Default< / h3 >
< p > A < strong > Default< / strong > plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.< / p >
2022-11-05 23:35:48 +00:00
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-a562a29d67a3a48b89e29aa145e3ea5c" class = "lightbox-link" >
2022-11-06 15:27:13 +00:00
< img src = "../cont/archetypes/pages-default.png?classes=shadow&width=60pc" alt = "Default page" class = "shadow" style = "height: auto; width: 60pc;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-a562a29d67a3a48b89e29aa145e3ea5c" >
2023-02-04 15:22:06 +00:00
< img src = "../cont/archetypes/pages-default.png?classes=shadow&width=60pc" alt = "Default page" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-07-05 22:16:52 +00:00
< p > T' create a default plank, run either one o' th' follow'n commands< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new < chapter> /< name> /_index.md
< / span > < / span > < / code > < / pre > < / div > < p > or< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new < chapter> /< name> .md
2022-07-05 22:16:52 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > This leads t' a file wit' th' follow'n rrrambl'n< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > +++
< / span > < / span > < span class = "line" > < span class = "cl" > title = " {{ replace .Name " -" " " | title }}"
< / span > < / span > < span class = "line" > < span class = "cl" > weight = X
< / span > < / span > < span class = "line" > < span class = "cl" > +++
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-07-05 22:16:52 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Lorem Ipsum.
2022-10-31 14:06:51 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > Replace th' < code > X< / code > wit' a number or delete th' whole < code > weight< / code > parameter entirely.< / p >
< h2 id = "self-defined-archetypes" > Self defined Archetypes< / h2 >
2022-07-05 22:16:52 +00:00
< p > If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.< / p >
< h3 id = "template" > Template< / h3 >
< p > Define a template file 'n yer project at < code > archetypes/< kind> .md< / code > an' make sure it has at least th' frontmatter parameter fer that archetype like< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > +++
< / span > < / span > < span class = "line" > < span class = "cl" > archetype = " < span class = "p" > < < / span > < span class = "nt" > kind< / span > < span class = "p" > > < / span > "
< / span > < / span > < span class = "line" > < span class = "cl" > +++
2022-10-31 14:06:51 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command< / p >
2022-07-05 22:16:52 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind < kind> < name> /_index.md
< / span > < / span > < / code > < / pre > < / div > < h3 id = "partials" > Partials< / h3 >
< p > T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory < code > layouts/partials/archetypes/< kind> < / code > .< / p >
< p > If ye use an unknown archetype 'n yer frontmatter, th' < code > default< / code > archetype will be used t' generate th' plank.< / p >
2022-07-14 20:20:11 +00:00
< p > Related t' each archetype, several < em > hook< / em > partial files 'n th' form o' < code > < hook> .html< / code > can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.< / p >
2022-07-05 22:16:52 +00:00
< p > Th' follow'n hooks be used:< / p >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > styleclass< / td >
< td style = "text-align:left" > Defines a set o' CSS classes t' be added t' th' HTML’ s < code > < main> < / code > element. Ye can use these classes t' define own CSS rules 'n yer < code > custom-header.html< / code > < / td >
< / tr >
< tr >
< td style = "text-align:left" > article< / td >
< td style = "text-align:left" > Defines th' HTML how t' render yer rrrambl'n< / td >
< / tr >
< / tbody >
< / table >
< p > Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.< / p >
2022-07-14 20:20:11 +00:00
< h4 id = "output-formats" > Output formats< / h4 >
2022-12-23 11:24:54 +00:00
< p > Each hook file can be overridden o' a specific < a href = "https://gohugo.io/templates/output-formats/" target = "_blank" > output format< / a > . Eg. if ye define a new output format < code > PLAINTEXT< / code > 'n yer < code > config.toml< / code > , ye can add a file < code > layouts/partials/archetypes/default.plaintext.html< / code > t' change th' way how normal rrrambl'n be written fer that output format.< / p >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "marrrkdown-rules" > Marrrkdown rules< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-12-02 15:05:54 +00:00
< 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 >
2022-04-02 13:30:16 +00:00
< 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 >
2022-12-02 15:05:54 +00:00
< li > Produces valid HTML output.< / li >
2022-04-02 13:30:16 +00:00
< 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’ ’ ’ ’
< cite > John Gruber< / cite > < / p >
< / blockquote >
< p > Without further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:< / p >
2022-12-02 15:05:54 +00:00
< div class = "box notices cstyle tip" >
< div class = "box-label" > < i class = "fa-fw fas fa-lightbulb" > < / i > Smarrrt Arrrse< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > < i class = "fa-fw fas fa-bookmark" > < / i > Bookmark this plank an' th' < a href = "https://commonmark.org/help/" target = "_blank" > official Commonmark reference< / a > fer easy future reference!< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-12-02 15:05:54 +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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< 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 >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "headings" > Head'ns< / h2 >
2022-12-02 15:05:54 +00:00
< 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 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "gh" > # h1 Head'n
2022-12-02 15:05:54 +00:00
< / 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" > < span class = "gu" > ###### h6 Head'n
< / span > < / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +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 >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "horizontal-rules" > Horizontal Rules< / h2 >
2022-12-02 15:05:54 +00:00
< 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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" > ---
< / 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 >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.< / p >
2022-04-02 13:30:16 +00:00
< hr >
2022-12-02 15:05:54 +00:00
< 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 >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h2 id = "text-markers" > Text Markers< / h2 >
2022-04-02 13:30:16 +00:00
< h3 id = "bold" > Bold< / h3 >
2022-12-02 15:05:54 +00:00
< 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > I am rendered wit' < span class = "gs" > **bold text**< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > I am rendered wit' < strong > bold text< / strong > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > I am rendered wit' < span class = "ge" > _italicized text_< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > I am rendered wit' < em > italicized text< / em > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "strikethrough" > Strikethrough< / h3 >
2022-12-02 15:21:29 +00:00
< p > In GFM (GitHub Flavored Markdown) ye can do strikethroughs by enclos'n text wit' two tildes < code > ~~< / code > .< / p >
2022-12-02 15:05:54 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ~~Strike through this text~~
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > < del > Strike through this text< / del > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h2 id = "text-substitution" > Text substitut'n< / h2 >
< p > This Marrrkdown dialect supports an extension t' 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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' **.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / 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 >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< 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 >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "lists" > Lists< / h2 >
< h3 id = "unordered" > Unordered< / h3 >
2022-12-02 15:05:54 +00:00
< 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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
2022-04-02 13:30:16 +00:00
< / 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
2022-12-02 15:05:54 +00:00
< / 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" > < span class = "k" > -< / span > Faucibus porta lacus fringilla vel
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< ul >
< li > Lorem ipsum dolor sit amet< / li >
2022-12-02 15:05:54 +00:00
< li > Consectetur adipisc'n elit
< ul >
< li > Vestibulum laoreet porttitor sem< / li >
< li > Ac tristique libero volutpat at< / li >
< / ul >
< / li >
2022-04-02 13:30:16 +00:00
< 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 >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< 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 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Lorem ipsum dolor sit amet
2022-12-02 15:05:54 +00:00
< / 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" > < span class = "k" > 17.< / span > Eget porttitor lorem
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< ol >
< li > Lorem ipsum dolor sit amet< / li >
2022-12-02 15:05:54 +00:00
< li > Consectetur adipisc'n elit
< ol >
2022-04-02 13:30:16 +00:00
< li > Integer molestie lorem at massa< / li >
< li > Facilisis 'n pretium nisl aliquet< / li >
2022-12-02 15:05:54 +00:00
< / ol >
< / li >
< li > Nulla volutpat aliquam velit
< ol >
2022-04-02 13:30:16 +00:00
< li > Faucibus porta lacus fringilla vel< / li >
< li > Aenean sit amet erat nunc< / li >
2022-12-02 15:05:54 +00:00
< / ol >
< / li >
2022-04-02 13:30:16 +00:00
< li > Eget porttitor lorem< / li >
< / ol >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "tasks" > Tasks< / h3 >
2022-12-02 15:21:29 +00:00
< p > In GFM (GitHub Flavored Markdown) ye can add task lists result'n 'n checked or unchecked non-click'ble items< / p >
2022-12-02 15:05:54 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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" > < span class = "k" > - [ ]< / span > Smell
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-12-02 15:05:54 +00:00
< div class = "box notices cstyle secondary" >
< 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" >
2022-12-02 15:05:54 +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 >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "defintions" > Defint'ns< / h3 >
< p > This Marrrkdown dialect supports an extension t' add defint'n lists. 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< 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 >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< h2 id = "code" > Code< / h2 >
2022-12-02 15:05:54 +00:00
< h3 id = "inline-code" > Inline Code< / h3 >
< p > Inline snippets o' code can be wrapped wit' backticks < code > `< / code > .< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > In this example, < span class = "sb" > `< div> < /div> `< / span > be marked as code.
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > In this example, < code > < div> < /div> < / code > be marked as code.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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
2022-04-02 13:30:16 +00:00
< / 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
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > Be impressed by my advanced code:< / p >
2022-04-02 13:30:16 +00:00
< pre > < code > // Some comments
line 1 o' code
line 2 o' code
line 3 o' code
< / code > < / pre >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< 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 > In GFM (GitHub Flavored Markdown) ye can also add a language specifier directly aft 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 >
2022-12-16 17:42:17 +00:00
< p > See < a href = "../cont/syntaxhighlight/" > Code Highlight'n< / a > fer additional documentat'n.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < 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" > grunt.initConfig({
< / span > < / span > < span class = "line" > < span class = "cl" > assemble: {
< / span > < / span > < span class = "line" > < span class = "cl" > opt'ns: {
< / span > < / span > < span class = "line" > < span class = "cl" > assets: ' docs/assets' ,
< / span > < / span > < span class = "line" > < span class = "cl" > data: ' src/data/*.{json,yml}' ,
< / span > < / span > < span class = "line" > < span class = "cl" > helpers: ' src/custom-helpers.js' ,
< / span > < / span > < span class = "line" > < span class = "cl" > partials: [' src/partials/**/*.{hbs,md}' ]
< / span > < / span > < span class = "line" > < span class = "cl" > },
< / span > < / span > < span class = "line" > < span class = "cl" > planks: {
< / span > < / span > < span class = "line" > < span class = "cl" > opt'ns: {
< / span > < / span > < span class = "line" > < span class = "cl" > layout: ' default.hbs'
< / span > < / span > < span class = "line" > < span class = "cl" > },
< / span > < / span > < span class = "line" > < span class = "cl" > files: {
< / span > < / span > < span class = "line" > < span class = "cl" > ' ./' : [' src/templates/pages/index.hbs' ]
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > };
< / span > < / span > < span class = "line" > < span class = "cl" > ```
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-js" data-lang = "js" > < span class = "line" > < span class = "cl" > < span class = "nx" > grunt< / span > < span class = "p" > .< / span > < span class = "nx" > initConfig< / span > < span class = "p" > ({< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > assemble< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > opt'ns< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > assets< / span > < span class = "o" > :< / span > < span class = "s1" > ' docs/assets' < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > data< / span > < span class = "o" > :< / span > < span class = "s1" > ' src/data/*.{json,yml}' < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > helpers< / span > < span class = "o" > :< / span > < span class = "s1" > ' src/custom-helpers.js' < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > partials< / span > < span class = "o" > :< / span > < span class = "p" > [< / span > < span class = "s1" > ' src/partials/**/*.{hbs,md}' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > planks< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > opt'ns< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > layout< / span > < span class = "o" > :< / span > < span class = "s1" > ' default.hbs' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > files< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s1" > ' ./' < / span > < span class = "o" > :< / span > < span class = "p" > [< / span > < span class = "s1" > ' src/templates/pages/index.hbs' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > };< / span >
2022-12-04 09:16:01 +00:00
< / span > < / span > < / code > < / pre > < / div > < / div >
2022-12-02 15:05:54 +00:00
< / div >
< h2 id = "tables" > Tables< / h2 >
2022-12-02 15:21:29 +00:00
< p > In GFM (GitHub Flavored Markdown) 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 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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. |
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< table >
< thead >
< tr >
< th > Opt'n< / th >
< th > Descript'n< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > data< / td >
< td > path t' data files t' supply th' data that will be passed into templates.< / td >
< / tr >
< tr >
< td > engine< / td >
< td > engine t' be used fer process'n templates. Handlebars be th' default.< / td >
< / tr >
< tr >
< td > ext< / td >
< td > extension t' be used fer dest files.< / td >
< / tr >
< / tbody >
< / table >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< table >
2022-04-02 13:30:16 +00:00
< thead >
< tr >
< th style = "text-align:right" > Opt'n< / th >
2022-12-02 15:05:54 +00:00
< th style = "text-align:center" > Number< / th >
< th style = "text-align:left" > Descript'n< / th >
2022-04-02 13:30:16 +00:00
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:right" > data< / td >
2022-12-02 15:05:54 +00:00
< 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 >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
< td style = "text-align:right" > engine< / td >
2022-12-02 15:05:54 +00:00
< 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 >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
< td style = "text-align:right" > ext< / td >
2022-12-02 15:05:54 +00:00
< td style = "text-align:center" > 3< / td >
< td style = "text-align:left" > extension t' be used fer dest files.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< / tbody >
< / table >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h2 id = "blockquotes" > Blockquotes< / h2 >
< 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 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 class = "k" > >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > < / span > < span class = "ge" > > 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 > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< blockquote >
< p > Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue 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 >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "links" > Links< / h2 >
2022-12-02 15:05:54 +00:00
< h3 id = "autolink" > Autolink< / h3 >
< p > In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > This be a link t' https://example.com.
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > This be a link t' < a href = "https://example.com" target = "_blank" > https://example.com< / a > .< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +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 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > [< span class = "nt" > Assemble< / span > ](< span class = "na" > http://assemble.io< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > < a href = "http://assemble.io" target = "_blank" > Assemble< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< 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 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > [< span class = "nt" > Upstage< / span > ](< span class = "na" > https://github.com/upstage/ " Visit Upstage!" < / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > < a href = "https://github.com/upstage/" title = "Visit Upstage!" target = "_blank" > Upstage< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > < a href = "https://example.com" title = "Go t' example domain" target = "_blank" > Example< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "footnotes" > Footnotes< / h3 >
< p > 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" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > That' s some text wit' a footnote[^1]
< / span > < / span > < span class = "line" > < span class = "cl" >
< / 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" >
2022-12-02 15:05:54 +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" >
2022-12-02 15:05:54 +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.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Blue light glows blue.
2022-10-08 19:39:32 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-12-02 15:05:54 +00:00
< div class = "box notices cstyle secondary" >
< 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" >
2022-12-02 15:05:54 +00:00
< 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 >
2022-12-04 09:16:01 +00:00
< / div >
2022-10-08 19:39:32 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "images" > Images< / h2 >
2022-12-02 15:05:54 +00:00
< h3 id = "basic-images" > Basic Images< / h3 >
< p > Images have a similar rules t' links but include a preced'n exclamat'n mark.< / p >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spock< / span > ](< span class = "na" > https://octodex.github.com/images/spocktocat.png< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-c72d5c0b393c47dd7a90ab6848d32726" class = "lightbox-link" >
2022-12-02 15:05:54 +00:00
< img src = "https://octodex.github.com/images/spocktocat.png?width=20vw&classes=bg-white" alt = "Spock" class = "bg-white" style = "height: auto; width: 20vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-c72d5c0b393c47dd7a90ab6848d32726" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/spocktocat.png?width=20vw&classes=bg-white" alt = "Spock" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "image-with-tooltip" > Image wit' Tooltip< / h3 >
< p > Like links, images can also be given a tooltip.< / p >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-a0bfec1cb041b3cc814117d0745d7f8e" class = "lightbox-link" >
2022-11-18 23:25:43 +00:00
< img src = "https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt = "Picard" title = "Jean Luc Picard" style = "height: auto; width: 20vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-a0bfec1cb041b3cc814117d0745d7f8e" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt = "Picard" title = "Jean Luc Picard" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / 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 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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"
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-fc05526f10ca6913589a5bc674059ace" class = "lightbox-link" >
2022-11-18 23:25:43 +00:00
< img src = "https://octodex.github.com/images/trekkie.jpg?width=20vw" alt = "La Forge" title = "Geordi La Forge" style = "height: auto; width: 20vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-fc05526f10ca6913589a5bc674059ace" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/trekkie.jpg?width=20vw" alt = "La Forge" title = "Geordi La Forge" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "further-image-formatting" > Further Image Formatt'n< / h3 >
< p > This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL.< / 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 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?width=20vw< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-298cf81fb3cf64bcde8e1d0c5c1fbe03" class = "lightbox-link" >
2022-12-02 15:05:54 +00:00
< img src = "https://octodex.github.com/images/minion.png?width=20vw&classes=bg-white" alt = "Minion" class = "bg-white" style = "height: auto; width: 20vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-298cf81fb3cf64bcde8e1d0c5c1fbe03" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/minion.png?width=20vw&classes=bg-white" alt = "Minion" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?height=50px< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-6bf709a6974ff228a08df99c31bb7f8f" class = "lightbox-link" >
2022-12-02 15:05:54 +00:00
< img src = "https://octodex.github.com/images/minion.png?height=50px&classes=bg-white" alt = "Minion" class = "bg-white" style = "height: 50px; width: auto;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-6bf709a6974ff228a08df99c31bb7f8f" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/minion.png?height=50px&classes=bg-white" alt = "Minion" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-e454a6366960988bf6ec4ec53ee5fe2b" class = "lightbox-link" >
2022-12-02 15:05:54 +00:00
< img src = "https://octodex.github.com/images/minion.png?height=50px&width=40vw&classes=bg-white" alt = "Minion" class = "bg-white" style = "height: 50px; width: 40vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-e454a6366960988bf6ec4ec53ee5fe2b" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/minion.png?height=50px&width=40vw&classes=bg-white" alt = "Minion" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< 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 >
2022-12-02 15:31:21 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spidertocat< / span > ](< span class = "na" > https://octodex.github.com/images/spidertocat.png?classes=shadow< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-918700cb2a860bbce6f6f3fc1bf111d2" class = "lightbox-link" >
2022-12-02 15:05:54 +00:00
< img src = "https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,bg-white" alt = "Spidertocat" class = "shadow bg-white" style = "height: auto; width: 20vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-918700cb2a860bbce6f6f3fc1bf111d2" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,bg-white" alt = "Spidertocat" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h5 id = "border" > Border< / h5 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > DrOctocat< / span > ](< span class = "na" > https://octodex.github.com/images/droctocat.png?classes=border< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-210d17ea4811b3109c15f647ad32b8bf" class = "lightbox-link" >
2022-11-18 23:25:43 +00:00
< img src = "https://octodex.github.com/images/droctocat.png?width=20vw&classes=border" alt = "DrOctocat" class = "border" style = "height: auto; width: 20vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-210d17ea4811b3109c15f647ad32b8bf" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/droctocat.png?width=20vw&classes=border" alt = "DrOctocat" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h5 id = "left" > Left< / h5 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-76419db6b4b82e103741d1abce5c9568" class = "lightbox-link" >
2022-11-18 23:25:43 +00:00
< img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt = "Supertocat" class = "left" style = "height: auto; width: 20vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-76419db6b4b82e103741d1abce5c9568" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt = "Supertocat" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h5 id = "right" > Right< / h5 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Riddlocat< / span > ](< span class = "na" > https://octodex.github.com/images/riddlocat.jpg?classes=right< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-f57b753f9992b5fd21b126ae31e90e88" class = "lightbox-link" >
2022-11-18 23:25:43 +00:00
< img src = "https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt = "Riddlocat" class = "right" style = "height: auto; width: 20vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-f57b753f9992b5fd21b126ae31e90e88" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt = "Riddlocat" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h5 id = "inline" > Inline< / h5 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-fcf3ece651808f82ddc68407fda9c5ce" class = "lightbox-link" >
2022-12-02 15:05:54 +00:00
< img src = "https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline,bg-white" alt = "Spidertocat" class = "inline bg-white" style = "height: auto; width: 10vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-fcf3ece651808f82ddc68407fda9c5ce" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline,bg-white" alt = "Spidertocat" class = "lightbox-image" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-a954cb302d4a4b359b743b691f017023" class = "lightbox-link" >
2022-11-18 23:25:43 +00:00
< img src = "https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt = "DrOctocat" class = "inline" style = "height: auto; width: 10vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-a954cb302d4a4b359b743b691f017023" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt = "DrOctocat" class = "lightbox-image" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-c63fd633a2205e32f6e8fe2066f0b232" class = "lightbox-link" >
2022-11-18 23:25:43 +00:00
< img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt = "Supertocat" class = "inline" style = "height: auto; width: 10vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-c63fd633a2205e32f6e8fe2066f0b232" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt = "Supertocat" class = "lightbox-image" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-d4be8353f6bdd4dbefa5b9766d2716a3" class = "lightbox-link" >
2022-11-18 23:25:43 +00:00
< img src = "https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt = "Riddlocat" class = "inline" style = "height: auto; width: 10vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-d4be8353f6bdd4dbefa5b9766d2716a3" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt = "Riddlocat" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-11-06 15:27:13 +00:00
< h5 id = "combination" > Combinat'n< / h5 >
2022-12-02 15:05:54 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < 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 secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-cbf48154093e78069bbabeb2157b1ffe" class = "lightbox-link" >
2022-11-18 23:25:43 +00:00
< img src = "https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt = "X-tocat" class = "shadow border left" style = "height: auto; width: 20vw;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-cbf48154093e78069bbabeb2157b1ffe" >
2023-02-04 15:22:06 +00:00
< img src = "https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt = "X-tocat" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h4 id = "lightbox" > Lightbox< / h4 >
2023-01-29 10:28:20 +00:00
< p > Add th' query parameter < code > lightbox=false< / code > t' th' image link t' dis'ble th' lightbox.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Homercat< / span > ](< span class = "na" > https://octodex.github.com/images/homercat.png?lightbox=false< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2023-01-29 10:28:20 +00:00
< img src = "https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false&classes=bg-white" alt = "Homercat" class = "bg-white" style = "height: auto; width: 20vw;" loading = "lazy" > < / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "code-highlightn" > Code highlight' n< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-12-23 11:24:54 +00:00
< p > Th' Relearrrn theme uses < a href = "https://gohugo.io/content-management/syntax-highlighting/" target = "_blank" > Hugo’ s built-in rules highlight'n< / a > fer code.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "markdown-syntax" > Marrrkdown rules< / h2 >
< p > Wrap th' code block wit' three backticks an' th' name o' th' language. Highlight will try t' auto detect th' language if one be not provided.< / p >
<!-- markdownlint - dis'ble MD046 -->
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ```json
< / span > < / span > < span class = "line" > < span class = "cl" > [
< / span > < / span > < span class = "line" > < span class = "cl" > {
< / span > < / span > < span class = "line" > < span class = "cl" > " title" : " apples" ,
< / span > < / span > < span class = "line" > < span class = "cl" > " count" : [12000, 20000],
< / span > < / span > < span class = "line" > < span class = "cl" > " description" : {" text" : " ..." , " sensitive" : false}
< / span > < / span > < span class = "line" > < span class = "cl" > },
< / span > < / span > < span class = "line" > < span class = "cl" > {
< / span > < / span > < span class = "line" > < span class = "cl" > " title" : " oranges" ,
< / span > < / span > < span class = "line" > < span class = "cl" > " count" : [17500, null],
< / span > < / span > < span class = "line" > < span class = "cl" > " description" : {" text" : " ..." , " sensitive" : false}
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > ]
< / span > < / span > < span class = "line" > < span class = "cl" > ```
< / span > < / span > < / code > < / pre > < / div > <!-- markdownlint - dis'ble MD046 -->
< p > Renders t':< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " apples" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " count" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span > < span class = "mi" > 12000< / span > < span class = "p" > ,< / span > < span class = "mi" > 20000< / span > < span class = "p" > ],< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " description" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span > < span class = "nt" > " text" < / span > < span class = "p" > :< / span > < span class = "s2" > " ..." < / span > < span class = "p" > ,< / span > < span class = "nt" > " sensitive" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " title" < / span > < span class = "p" > :< / span > < span class = "s2" > " oranges" < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " count" < / span > < span class = "p" > :< / span > < span class = "p" > [< / span > < span class = "mi" > 17500< / span > < span class = "p" > ,< / span > < span class = "kc" > null< / span > < span class = "p" > ],< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " description" < / span > < span class = "p" > :< / span > < span class = "p" > {< / span > < span class = "nt" > " text" < / span > < span class = "p" > :< / span > < span class = "s2" > " ..." < / span > < span class = "p" > ,< / span > < span class = "nt" > " sensitive" < / span > < span class = "p" > :< / span > < span class = "kc" > false< / span > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > ]< / span >
< / span > < / span > < / code > < / pre > < / div > < h2 id = "supported-languages" > Supported languages< / h2 >
2022-12-23 11:24:54 +00:00
< p > Cap'n Hugo comes wit' a < a href = "https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" target = "_blank" > remark'ble list< / a > o' supported languages.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "recommended-configuration" > Recommended configurat'n< / h2 >
2022-12-23 11:24:54 +00:00
< p > Ye can choose a color theme from th' < a href = "https://xyproto.github.io/splash/docs/all.html" target = "_blank" > list o' supported themes< / a > an' add it 'n yer < code > config.toml< / code > < / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > marrrkup< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > marrrkup< / span > < span class = "p" > .< / span > < span class = "nx" > highlight< / span > < span class = "p" > ]< / span >
2023-01-14 00:40:32 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # if `guessSyntax = true`, there will be no unstyled code even if no language< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # mandatory sett'n fer yer ship if ye want t' use Merrrmaid or Math codefences< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > guessSyntax< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # choose a color theme or create yer own< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s2" > " base16-snazzy" < / span >
< / span > < / span > < / code > < / pre > < / div >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "menu-extrrra-shorrrtcuts" > Menu extrrra shorrrtcuts< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > Ye can define additional menu entries or shortcuts 'n th' navigat'n menu without any link t' rrrambl'n.< / p >
< h2 id = "basic-configuration" > Basic configurat'n< / h2 >
< p > Edit th' website configurat'n < code > config.toml< / code > an' add a < code > [[menu.shortcuts]]< / code > entry fer each link yer want t' add.< / p >
< p > Example from th' current website:< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fab fa-fw fa-github' > < /i> GitHub repo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " ds" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://github.com/McShelby/hugo-theme-relearn" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 10< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-camera' > < /i> Showcases" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " more/showcase/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 11< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bookmark' > < /i> Cap'n Hugo Documentation" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " hugodoc" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 20< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bullhorn' > < /i> Credits" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " more/credits/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 30< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-tags' > < /i> Tags" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " tags/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 40< / span >
< / span > < / span > < / code > < / pre > < / div > < p > By default, shortcuts be preceded by a title. This title can be disabled by sett'n < code > disableShortcutsTitle=true< / code > .
2022-10-31 14:06:51 +00:00
However, if ye want t' keep th' title but change its value, it can be overridden by chang'n yer local i18n translat'n str'n configurat'n.< / p >
2022-04-02 13:30:16 +00:00
< p > For example, 'n yer local < code > i18n/en.toml< / code > file, add th' follow'n rrrambl'n< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > Shortcuts-Title< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > other< / span > < span class = "p" > =< / span > < span class = "s2" > " < Your value> " < / span >
2022-12-23 11:24:54 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > Read more about < a href = "https://gohugo.io/extras/menus/" target = "_blank" > hugo menu< / a > an' < a href = "https://gohugo.io/content-management/multilingual/#translation-of-strings" target = "_blank" > hugo i18n translat'n str'ns< / a > < / p >
2022-04-02 13:30:16 +00:00
< h2 id = "i18n" > Configurat'n fer Multilingual mode< / h2 >
< p > When us'n a multilingual website, ye can set different menus fer each language. In th' < code > config.toml< / code > file, prefix yer menu configurat'n by < code > Languages.< language-id> < / code > .< / p >
< p > Example from th' current website:< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > Languages< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Hugo Relearrrn Theme" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > languageName< / span > < span class = "p" > =< / span > < span class = "s2" > " English" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageURL< / span > < span class = "p" > =< / span > < span class = "s2" > " /" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageName< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-home' > < /i> Home" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fab fa-fw fa-github' > < /i> GitHub repo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " ds" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://github.com/McShelby/hugo-theme-relearn" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 10< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-camera' > < /i> Showcases" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " more/showcase/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 11< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bookmark' > < /i> Cap'n Hugo Documentation" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " hugodoc" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 20< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bullhorn' > < /i> Credits" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " more/credits/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 30< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-tags' > < /i> Tags" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " tags/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 40< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Cap' n Hugo Relearrrn Theme" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > languageName< / span > < span class = "p" > =< / span > < span class = "s2" > " Arrr! Pirrrates" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageURL< / span > < span class = "p" > =< / span > < span class = "s2" > " /pir/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageName< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-home' > < /i> Arrr! Home" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fab fa-fw fa-github' > < /i> GitHub repo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " ds" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://github.com/McShelby/hugo-theme-relearn" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 10< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-camera' > < /i> Showcases" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " more/showcase/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 11< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bookmark' > < /i> Cap' n Hugo Documentat' n" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " hugodoc" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 20< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bullhorn' > < /i> Crrredits" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " more/credits/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 30< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-tags' > < /i> Arrr! Tags" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " tags/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 40< / span >
2022-12-23 11:24:54 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > Read more about < a href = "https://gohugo.io/extras/menus/" target = "_blank" > hugo menu< / a > an' < a href = "https://gohugo.io/content-management/multilingual/#menus" target = "_blank" > hugo multilingual menus< / a > < / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "multilingual-an-i18n" > Multilingual an' i18n< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > Th' Relearrrn theme be fully compat'ble wit' Cap'n Hugo multilingual mode.< / p >
< ul >
2023-02-10 21:58:51 +00:00
< li > Avail'ble languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese. Feel free t' contribute!< / li >
2023-02-09 23:35:46 +00:00
< li > Full support fer languages written right t' left< / li >
2022-04-02 13:30:16 +00:00
< li > Automatic menu generat'n from multilingual rrrambl'n< / li >
< li > In-browser language switch'n< / li >
< / ul >
2022-11-05 23:35:48 +00:00
< p >
2022-11-06 15:27:13 +00:00
2023-02-10 23:05:55 +00:00
< a href = "#image-ee1ce16ba51e0c5bff61b3c7d638e384" class = "lightbox-link" >
2022-11-06 15:27:13 +00:00
< img src = "../cont/i18n/i18n-menu.gif?classes=shadow&width=300px" alt = "I18n menu" class = "shadow" style = "height: auto; width: 300px;" loading = "lazy" >
2023-01-29 10:28:20 +00:00
< / a >
2023-02-10 23:05:55 +00:00
< a href = "javascript:history.back();" class = "lightbox" id = "image-ee1ce16ba51e0c5bff61b3c7d638e384" >
2023-02-04 15:22:06 +00:00
< img src = "../cont/i18n/i18n-menu.gif?classes=shadow&width=300px" alt = "I18n menu" class = "lightbox-image" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-04-02 13:30:16 +00:00
< h2 id = "basic-configuration" > Basic configurat'n< / h2 >
2022-12-23 11:24:54 +00:00
< p > Aft learn'n < a href = "https://gohugo.io/content-management/multilingual" target = "_blank" > how Cap'n Hugo handle multilingual websites< / a > , define yer languages 'n yer < code > config.toml< / code > file.< / p >
2022-04-02 13:30:16 +00:00
< p > For example wit' current English an' Piratized English website.< / p >
2023-01-25 11:42:06 +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 > Make sure yer default language be defined as th' first one 'n th' < code > [Languages]< / code > array, as th' theme needs t' make assumpt'ns on it< / p >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "c" > # English be th' default language< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > defaultContentLanguage< / span > < span class = "p" > =< / span > < span class = "s2" > " en" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > Languages< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Hugo Relearrrn Theme" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > languageName< / span > < span class = "p" > =< / span > < span class = "s2" > " English" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > Languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Cap' n Hugo Relearrrn Theme" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 2< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > languageName< / span > < span class = "p" > =< / span > < span class = "s2" > " Arrr! Pirrrates" < / span >
< / span > < / span > < / code > < / pre > < / div > < p > Then, fer each new plank, append th' < em > id< / em > o' th' language t' th' file.< / p >
< ul >
< li > Single file < code > my-page.md< / code > be split 'n two files:
< ul >
< li > 'n English: < code > my-page.md< / code > < / li >
< li > 'n Piratized English: < code > my-page.pir.md< / code > < / li >
< / ul >
< / li >
< li > Single file < code > _index.md< / code > be split 'n two files:
< ul >
< li > 'n English: < code > _index.md< / code > < / li >
< li > 'n Piratized English: < code > _index.pir.md< / code > < / li >
< / ul >
< / li >
< / ul >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle info" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-info-circle" > < / i > Ahoi< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > Be aware that only translated planks be displayed 'n menu. It’ s not replaced wit' default language rrrambl'n.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle tip" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-lightbulb" > < / i > Smarrrt Arrrse< / div >
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > Use < a href = "https://gohugo.io/content-management/multilingual/#translate-your-content" target = "_blank" > slug< / a > frontmatter parameter t' translate urls too.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-12 17:25:16 +00:00
< h2 id = "search" > Search< / h2 >
< p > In case each page’ s rrrambl'n be written 'n one single language only, th' above configurat'n will already configure th' site’ s search functionality correctly.< / p >
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > Arrr< / div >
< div class = "box-content" >
2023-01-30 17:00:33 +00:00
< p > Although th' theme supports a wide variety o' supported languages, th' site’ s search via th' < a href = "https://lunrjs.com" target = "_blank" > Lunr< / a > search library does not.
2022-06-12 17:25:16 +00:00
You’ ll see error reports 'n yer browsers console log fer each unsupported language. Currently unsupported be:< / p >
< ul >
2023-01-30 17:00:33 +00:00
< li > Czech< / li >
2022-06-12 17:25:16 +00:00
< li > Indonesian< / li >
< li > Polish< / li >
< / ul >
2022-12-04 09:16:01 +00:00
< / div >
2022-06-12 17:25:16 +00:00
< / div >
< h3 id = "search-with-mixed-language-support" > Search wit' mixed language support< / h3 >
2022-10-31 14:06:51 +00:00
< p > In case yer page’ s rrrambl'n contains text 'n multiple languages (e.g. ye be writ'n a Russian documentat'n fer yer english API), ye can add those languages t' yer < code > config.toml< / code > t' broaden search.< / p >
2022-06-12 17:25:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > additionalContentLanguage< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " en" < / span > < span class = "p" > ]< / span >
< / span > < / span > < / code > < / pre > < / div > < p > As this be an array, ye can add multiple additional languages.< / p >
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-10-31 14:06:51 +00:00
< p > Keep 'n mind that th' language code required here, be th' base language code. E.g. if ye have additional rrrambl'n 'n < code > zh-CN< / code > , ye have t' add just < code > zh< / code > t' this parameter.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-06-12 17:25:16 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "overwrite-translation-strings" > Overwrite translat'n str'ns< / h2 >
< p > Translat'ns str'ns be used fer common default values used 'n th' theme (< em > Edit< / em > button, < em > Search placeholder< / em > an' so on). Translat'ns be avail'ble 'n English an' Piratized English but ye may use another language or want t' override default values.< / p >
< p > T' override these values, create a new file 'n yer local i18n folder < code > i18n/< idlanguage> .toml< / code > an' inspire yourself from th' theme < code > themes/hugo-theme-relearn/i18n/en.toml< / code > < / p >
< h2 id = "disable-language-switching" > Dis'ble language switch'n< / h2 >
< p > Switch'n th' language 'n th' browser be a great feature, but fer some reasons ye may want t' dis'ble it.< / p >
< p > Just set < code > disableLanguageSwitchingButton=true< / code > 'n yer < code > config.toml< / code > < / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
2022-10-31 14:06:51 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # When us'n multilingual website, dis'ble th' switch language button.< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableLanguageSwitchingButton< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < / code > < / pre > < / div >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "tags" > Tags< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > Th' Relearrrn theme supports one default taxonomy o' Cap'n Hugo: th' < em > tag< / em > feature.< / p >
< h2 id = "configuration" > Configurat'n< / h2 >
< p > Just add tags t' any plank:< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > tags< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " tutorial" < / span > < span class = "p" > ,< / span > < span class = "s2" > " theme" < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Theme tutorial" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 15< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < / code > < / pre > < / div > < h2 id = "behavior" > Behavior< / h2 >
< p > Th' tags be displayed at th' top o' th' plank, 'n their insert'n order.< / p >
< p > Each tag be a link t' a < em > Taxonomy< / em > plank display'n all th' articles wit' th' given tag.< / p >
< h2 id = "list-all-the-tags" > List all th' tags< / h2 >
< p > In th' < code > config.toml< / code > file ye can add a shortcut t' display all th' tags< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-tags' > < /i> Tags" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " /tags" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 30< / span >
< / span > < / span > < / code > < / pre > < / div >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< / section >
2022-11-07 19:58:08 +00:00
< article class = "chapter" >
2022-07-05 22:16:52 +00:00
< div class = "article-subheading" > T' chapterrr 3< / div >
2022-11-13 21:34:47 +00:00
< h1 id = "shorrrtcodes" > Shorrrtcodes< / h1 >
2022-04-02 13:30:16 +00:00
< p > Cap'n Hugo uses Marrrkdown fer its simple rrrambl'n format. However, there be a lot o' th'ns that Marrrkdown doesn’ < / p >
< p > But this happens t' be a bad idea. Everyone uses Marrrkdown because it’ s pure an' simple t' read even non-rendered. Ye should avoid HTML t' keep it as simple as poss'ble.< / p >
2023-01-24 22:59:44 +00:00
< p > T' avoid this limitat'ns, Cap'n Hugo created < a href = "https://gohugo.io/extras/shortcodes/" target = "_blank" > shorrrtcodes< / a > . A shortcode be a simple snippet inside a plank.< / p >
2022-04-02 13:30:16 +00:00
< p > Th' Relearrrn theme provides multiple shorrrtcodes on top o' exist'n ones.< / p >
< div class = "children children-h2 children-sort-" >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/attachments/index.html" > Attachments< / a > < / h2 > < p > List o' files attached t' a plank< / p >
2022-12-01 00:38:08 +00:00
< h2 > < a href = "../shortcodes/badge/index.html" > Badge< / a > < / h2 > < p > Marker badges t' display 'n yer text< / p >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/button/index.html" > Button< / a > < / h2 > < p > Click'ble buttons< / p >
< h2 > < a href = "../shortcodes/children/index.html" > Children< / a > < / h2 > < p > List th' child planks o' a plank< / p >
< h2 > < a href = "../shortcodes/expand/index.html" > Expand< / a > < / h2 > < p > Expandable/collaps'ble sections o' text< / p >
2022-12-02 17:32:53 +00:00
< h2 > < a href = "../shortcodes/icon/index.html" > Ay'con< / a > < / h2 > < p > Nice ay'cons fer yer plank< / p >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/include/index.html" > Include< / a > < / h2 > < p > Displays rrrambl'n from other files< / p >
< h2 > < a href = "../shortcodes/math/index.html" > Math< / a > < / h2 > < p > Beautiful math an' chemical formulae< / p >
< h2 > < a href = "../shortcodes/mermaid/index.html" > Merrrmaid< / a > < / h2 > < p > Generate diagrams an' flowcharts from text< / p >
< h2 > < a href = "../shortcodes/notice/index.html" > Notice< / a > < / h2 > < p > Disclaimers t' help ye structure yer plank< / p >
< h2 > < a href = "../shortcodes/siteparam/index.html" > Ship param< / a > < / h2 > < p > Get value o' ship params< / p >
< h2 > < a href = "../shortcodes/swagger/index.html" > Swagger< / a > < / h2 > < p > UI fer yer Swagger / OpenAPI Specificat'ns< / p >
2023-01-14 00:40:32 +00:00
< h2 > < a href = "../shortcodes/tabs/index.html" > Tabs< / a > < / h2 > < p > Show rrrambl'n 'n tabbed views< / p >
2022-04-02 13:30:16 +00:00
< / div >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsct' ns o' Shorrrtcodes< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "attachments" > Attachments< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle transparent" >
< div class = "box-label" > < i class = "fa-fw fas fa-paperclip" > < / i > Attachments< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2022-11-05 23:35:48 +00:00
< li > < a href = "../shortcodes/attachments.pir.files/NoTreasure.txt" > NoTreasure.txt< / a > (26 B)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
2023-01-24 22:59:44 +00:00
< p > Th' < code > attachments< / code > shortcode displays a list o' files attached t' a plank wit' adjust'ble color, title an' ay'con.< / p >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle transparent" >
< div class = "box-label" > < i class = "fa-fw fas fa-paperclip" > < / i > Attachments< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2022-11-05 23:35:48 +00:00
< li > < a href = "../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/BachGavotteShort.mp3" > BachGavotteShort.mp3< / a > (357 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.txt" > hugo.txt< / a > (20 B)< / li >
< li > < a href = "../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.< / p >
2022-06-22 22:08:50 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > attachments< / span > < span class = "nx" > sort< / span > < span class = "p" > =< / span > < span class = "s" > " asc" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/attachments.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " sort" < / span > < span class = "s" > " asc" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2023-01-23 22:49:15 +00:00
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > style< / strong > < / td >
< td style = "text-align:left" > < code > transparent< / code > < / td >
2023-01-23 23:14:54 +00:00
< td style = "text-align:left" > Th' style scheme used fer th' box.< br > < br > - by severity: < code > info< / code > , < code > note< / code > , < code > tip< / code > , < code > warning< / code > < br > - by brand color: < code > primary< / code > , < code > secondary< / code > , < code > accent< / code > < br > - by color: < code > blue< / code > , < code > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > < / td >
2023-01-23 22:49:15 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > color< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > Th' < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > t' be used. If not set, th' chosen color depends on th' < strong > style< / strong > . Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n color fer th' severity< br > - fer all other styles: th' correspond'n color< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > title< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > Arbitrary text fer th' box title. Depend'n on th' < strong > style< / strong > there may be a default title. Any given value will overwrite th' default.< br > < br > - fer severity styles: th' match'n title fer th' severity< br > - fer all other styles: < code > Attachments< / code > < br > < br > If ye want no title fer a severity style, ye have t' set this parameter t' < code > " " < / code > (a non empty str'n filled wit' spaces)< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > ay'con< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > < a href = "../shortcodes/icon/#finding-an-icon" > Font Awesome ay'con name< / a > set t' th' left o' th' title. Depend'n on th' < strong > style< / strong > there may be a default ay'con. Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n ay'con fer th' severity< br > - fer all other styles: < code > paperclip< / code > < br > < br > If ye want no ay'con, ye have t' set this parameter t' < code > " " < / code > (a non empty d wit' spaces)< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > sort< / strong > < / td >
< td style = "text-align:left" > < code > asc< / code > < / td >
< td style = "text-align:left" > Sort'n th' output 'n < code > asc< / code > end'n or < code > desc< / code > end'n order.< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > pattern< / strong > < / td >
< td style = "text-align:left" > < code > .*< / code > < / td >
< td style = "text-align:left" > A < a href = "https://en.wikipedia.org/wiki/Regular_expression" target = "_blank" > regular expressions< / a > , used t' filter th' attachments by file name. For example:< br > < br > - t' match a file suffix o' ‘ jpg’ , use < code > .*\.jpg< / code > (not < code > *.\.jpg< / code > )< br > - t' match file names end'n 'n < code > jpg< / code > or < code > png< / code > , use < code > .*\.(jpg|png)< / code > < / td >
< / tr >
< / tbody >
< / table >
< h2 id = "setup" > Setup< / h2 >
< h3 id = "single-language" > Single language< / h3 >
2023-01-24 22:59:44 +00:00
< p > Th' shortcode lists files found 'n a specific folder. Th' name o' th' folder depends on yer plank type (either branch bundle, leaf bundle or page).< / p >
2022-04-02 13:30:16 +00:00
< ol >
< li >
2022-12-23 02:25:15 +00:00
< p > For simple planks, attachments must be placed 'n a folder named like yer plank an' end'n wit' < code > .files< / code > .< / p >
2022-04-02 13:30:16 +00:00
< blockquote >
< ul >
< li > rrrambl'n
< ul >
< li > _index.md< / li >
2022-06-05 17:32:37 +00:00
< li > < strong > plank.files< / strong >
2022-04-02 13:30:16 +00:00
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< li > plank.md< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
< / li >
< li >
2023-01-14 00:40:32 +00:00
< p > If yer plank be a branch or leaf bundle, attachments must be placed 'n a nested < code > _index.files< / code > or < code > index.files< / code > folder, accordingly.< / p >
2022-12-23 02:25:15 +00:00
< p > For branch bundles:< / p >
2022-04-02 13:30:16 +00:00
< blockquote >
< ul >
< li > rrrambl'n
< ul >
< li > _index.md< / li >
< li > plank
< ul >
< li > index.md< / li >
2022-12-23 02:25:15 +00:00
< li > < strong > index.files< / strong >
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
< p > For leaf bundles:< / p >
< blockquote >
< ul >
< li > rrrambl'n
< ul >
< li > _index.md< / li >
< li > plank
< ul >
< li > _index.md< / li >
< li > < strong > _index.files< / strong >
2022-04-02 13:30:16 +00:00
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
< / li >
< / ol >
2023-01-23 22:49:15 +00:00
< h3 id = "multilingual" > Multilingual< / h3 >
2022-12-23 02:25:15 +00:00
< p > Be aware that if ye use a multilingual website, ye will need t' have as many folders as languages an' th' language code must be part o' th' folder name.< / p >
< p > Eg. fer a ship 'n English an' Piratish:< / p >
< blockquote >
< ul >
< li > rrrambl'n
< ul >
< li > _index.en.md< / li >
< li > _index.pir.md< / li >
< li > < strong > plank.en.files< / strong >
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< li > < strong > plank.pir.files< / strong >
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< li > plank.en.md< / li >
< li > plank.pir.md< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
2022-05-25 21:31:08 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-06-05 17:32:37 +00:00
< h3 id = "custom-title-list-of-attachments-ending-in-pdf-or-mp4" > Custom Title, List o' Attachments End'n 'n pdf or mp4< / h3 >
2023-01-14 00:40:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > attachments< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Related files" < / span > < span class = "nx" > pattern< / span > < span class = "p" > =< / span > < span class = "s" > " .*\.(pdf|mp4)" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle transparent" >
< div class = "box-label" > < i class = "fa-fw fas fa-paperclip" > < / i > Related files< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2022-11-05 23:35:48 +00:00
< li > < a href = "../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "info-styled-box-descending-sort-order" > Ahoi Styled Box, Descend'n Sort Order< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > attachments< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > sort< / span > < span class = "p" > =< / span > < span class = "s" > " desc" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
2022-05-25 21:31:08 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle info" >
< div class = "box-label" > < i class = "fa-fw fas fa-info-circle" > < / i > Ahoi< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2022-11-05 23:35:48 +00:00
< li > < a href = "../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.txt" > hugo.txt< / a > (20 B)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/BachGavotteShort.mp3" > BachGavotteShort.mp3< / a > (357 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
2023-01-23 22:49:15 +00:00
< h3 id = "with-user-defined-color-and-font-awesome-brand-icon" > Wit' User-Defined Color an' Font Awesome Brand Ay'con< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > attachments< / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box attachments cstyle default" style = "--VARIABLE-BOX-color: fuchsia;" >
< div class = "box-label" > < i class = "fab fa-hackerrank" > < / i > Attachments< / div >
< ul class = "box-content attachments-files" >
< li > < a href = "../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/BachGavotteShort.mp3" > BachGavotteShort.mp3< / a > (357 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.txt" > hugo.txt< / a > (20 B)< / li >
< li > < a href = "../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
< / ul >
< / div >
< h3 id = "style-color-title-and-icons" > Style, Color, Title an' Ay'cons< / h3 >
2023-01-24 22:59:44 +00:00
< p > For further examples fer < strong > style< / strong > , < strong > color< / strong > , < strong > title< / strong > an' < strong > ay'con< / strong > , see th' < a href = "../shortcodes/notice/" > < code > notice< / code > shortcode< / a > documentat'n. Th' parameter be work'n th' same way fer both shorrrtcodes, besides hav'n different defaults.< / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-12-02 17:32:53 +00:00
< h1 id = "badge" > Badge< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2023-01-24 22:59:44 +00:00
< p > Th' < code > badge< / code > shortcode displays little markers 'n yer text wit' adjust'ble color, title an' ay'con.< / p >
2022-12-01 00:38:08 +00:00
< p > < span class = "badge cstyle default" > < span class = "badge-content" > Important< / span > < / span >
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > Version< / span > < span class = "badge-content" > 6.6.6< / span > < / span >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > < / span > < span class = "badge-content" > Captain< / span > < / span >
2023-01-23 22:49:15 +00:00
< span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-info-circle" > < / i > Ahoi< / span > < span class = "badge-content" > New< / span > < / span >
< span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > Awesome< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.< / p >
2022-12-01 00:38:08 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-12-01 00:38:08 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-12-01 00:38:08 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-12-01 00:38:08 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-12-01 00:38:08 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-12-01 00:38:08 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-12-01 00:38:08 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Important< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Version" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2023-01-23 22:49:15 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > New< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-12-01 00:38:08 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/badge.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Important" < / 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 class = "nx" > partial< / span > < span class = "s" > " shortcodes/badge.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " style" < / span > < span class = "s" > " primary" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " title" < / span > < span class = "s" > " Version" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " 6.6.6" < / 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 class = "nx" > partial< / span > < span class = "s" > " shortcodes/badge.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " style" < / span > < span class = "s" > " red" < / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " angle-double-up" < / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Captain" < / 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 class = "nx" > partial< / span > < span class = "s" > " shortcodes/badge.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " style" < / span > < span class = "s" > " info" < / span >
2023-01-23 22:49:15 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " New" < / 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 class = "nx" > partial< / span > < span class = "s" > " shortcodes/badge.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " color" < / span > < span class = "s" > " fuchsia" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " fab fa-hackerrank" < / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Awesome" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > style< / strong > < / td >
2022-12-01 08:14:48 +00:00
< td style = "text-align:left" > < code > default< / code > < / td >
2023-01-23 23:14:54 +00:00
< td style = "text-align:left" > Th' style scheme used fer th' badge.< br > < br > - by severity: < code > info< / code > , < code > note< / code > , < code > tip< / code > , < code > warning< / code > < br > - by brand color: < code > primary< / code > , < code > secondary< / code > , < code > accent< / code > < br > - by color: < code > blue< / code > , < code > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > < / td >
2022-12-01 00:38:08 +00:00
< / tr >
< tr >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > < strong > color< / strong > < / td >
2022-12-01 00:38:08 +00:00
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > Th' < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > t' be used. If not set, th' chosen color depends on th' < strong > style< / strong > . Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n color fer th' severity< br > - fer all other styles: th' correspond'n color< / td >
2022-12-01 00:38:08 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > title< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > Arbitrary text fer th' badge title. Depend'n on th' < strong > style< / strong > there may be a default title. Any given value will overwrite th' default.< br > < br > - fer severity styles: th' match'n title fer th' severity< br > - fer all other styles: < em > < empty> < / em > < br > < br > If ye want no title fer a severity style, ye have t' set this parameter t' < code > " " < / code > (a non empty str'n filled wit' spaces)< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > ay'con< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > < a href = "../shortcodes/icon/#finding-an-icon" > Font Awesome ay'con name< / a > set t' th' left o' th' title. Depend'n on th' < strong > style< / strong > there may be a default ay'con. Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n ay'con fer th' severity< br > - fer all other styles: < em > < empty> < / em > < br > < br > If ye want no ay'con fer a severity style, ye have t' set this parameter t' < code > " " < / code > (a non empty str'n filled wit' spaces)< / td >
2022-12-01 00:38:08 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
2022-12-01 08:14:48 +00:00
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > Arbitrary text fer th' badge.< / td >
2022-12-01 00:38:08 +00:00
< / tr >
< / tbody >
< / table >
< h2 id = "examples" > Examples< / h2 >
< h3 id = "style" > Style< / h3 >
< h4 id = "by-severity" > By Severity< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > New< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " note" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Change< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " tip" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Optional< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Break'n< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-info-circle" > < / i > Ahoi< / span > < span class = "badge-content" > New< / span > < / span >
< span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / span > < span class = "badge-content" > Change< / span > < / span >
< span class = "badge cstyle tip badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-lightbulb" > < / i > Smarrrt Arrrse< / span > < span class = "badge-content" > Optional< / span > < / span >
< span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > Arrr< / span > < span class = "badge-content" > Break'n< / span > < / span > < / p >
< h4 id = "by-brand-colors" > By Brand Colors< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " bullhorn" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Announcement" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Mandatory< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " secondary" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " bullhorn" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Announcement" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Optional< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2023-01-23 23:14:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " accent" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " bullhorn" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Announcement" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Special< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-bullhorn" > < / i > Announcement< / span > < span class = "badge-content" > Mandatory< / span > < / span >
2023-01-23 23:14:54 +00:00
< span class = "badge cstyle secondary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-bullhorn" > < / i > Announcement< / span > < span class = "badge-content" > Optional< / span > < / span >
< span class = "badge cstyle accent badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-bullhorn" > < / i > Announcement< / span > < span class = "badge-content" > Special< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h4 id = "by-color" > By Color< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Blue< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " green" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Green< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " grey" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Grey< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " orange" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Orange< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Red< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle blue badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Blue< / span > < / span >
< span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Green< / span > < / span >
< span class = "badge cstyle grey badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Grey< / span > < / span >
< span class = "badge cstyle orange badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Orange< / span > < / span >
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Red< / span > < / span > < / p >
< h4 id = "by-special-color" > By Special Color< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " default" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Default< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " transparent" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Transparent< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Default< / span > < / span >
< span class = "badge cstyle transparent badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Transparent< / span > < / span > < / p >
< h3 id = "variants" > Variants< / h3 >
< h4 id = "without-icon-and-title-text" > Without Ay'con an' Title Text< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default" > < span class = "badge-content" > 6.6.6< / span > < / span >
< span class = "badge cstyle info" > < span class = "badge-content" > Awesome< / span > < / span >
< span class = "badge cstyle red" > < span class = "badge-content" > Captain< / span > < / span > < / p >
< h4 id = "without-icon" > Without Ay'con< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Version" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > Version< / span > < span class = "badge-content" > 6.6.6< / span > < / span >
< span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > Ahoi< / span > < span class = "badge-content" > Awesome< / span > < / span >
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > Rank< / span > < span class = "badge-content" > Captain< / span > < / span > < / p >
< h4 id = "without-title-text" > Without Title Text< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " star" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-star" > < / i > < / span > < span class = "badge-content" > 6.6.6< / span > < / span >
< span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-info-circle" > < / i > < / span > < span class = "badge-content" > Awesome< / span > < / span >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > < / span > < span class = "badge-content" > Captain< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h4 id = "all-set" > All Set< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " star" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Version" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-star" > < / i > Version< / span > < span class = "badge-content" > 6.6.6< / span > < / span >
< span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-info-circle" > < / i > Ahoi< / span > < span class = "badge-content" > Awesome< / span > < / span >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > Rank< / span > < span class = "badge-content" > Captain< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h4 id = "override-for-severity" > Override fer Severity< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " rocket" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Feature" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-rocket" > < / i > Feature< / span > < span class = "badge-content" > Awesome< / span > < / span >
< h3 id = "other" > Other< / h3 >
2023-01-23 22:49:15 +00:00
< h4 id = "with-user-defined-color-and-font-awesome-brand-icon" > Wit' User-Defined Color an' Font Awesome Brand Ay'con< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > Awesome< / span > < / span >
2022-12-02 17:32:53 +00:00
< h4 id = "with-icon-content" > Wit' Ay'con Rrrambl'n< / h4 >
2023-01-24 22:59:44 +00:00
< p > Ye can combine th' badge wit' th' < a href = "../shortcodes/icon/" > < code > ay'con< / code > shortcode< / a > t' create even more stunn'n visuals.< / p >
2022-12-02 17:32:53 +00:00
< p > In this case ye need t' declare < code > {{< badge > }}< / code > instead o' < code > {{% badge %}}< / code > . Avast, that 'n this case it be not poss'ble t' put markdown 'n th' rrrambl'n.< / p >
2022-12-02 18:27:40 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "p" > > }}{{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > skull< / span > < span class = "o" > -< / span > < span class = "nx" > crossbones< / span > < span class = "o" > %< / span > < span class = "p" > }}{{< < / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "p" > > }}{{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > skull< / span > < span class = "o" > -< / span > < span class = "nx" > crossbones< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Pirate< / span > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < span class = "p" > > }}{{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > skull< / span > < span class = "o" > -< / span > < span class = "nx" > crossbones< / span > < span class = "o" > %< / span > < span class = "p" > }}{{< < / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < span class = "p" > > }}{{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > skull< / span > < span class = "o" > -< / span > < span class = "nx" > crossbones< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Pirate< / span > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < span class = "p" > > }}{{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > skull< / span > < span class = "o" > -< / span > < span class = "nx" > crossbones< / span > < span class = "o" > %< / span > < span class = "p" > }}{{< < / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < span class = "p" > > }}{{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > skull< / span > < span class = "o" > -< / span > < span class = "nx" > crossbones< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Pirate< / span > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > < / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > < / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > < / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > Pirate< / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > Rank< / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > < / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > Rank< / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > Pirate< / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > Rank< / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > < / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > Rank< / span > < span class = "badge-content" >
< i class = "fa-fw fas fa-skull-crossbones" > < / i > Pirate< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h4 id = "inside-of-text" > Inside o' Text< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "nx" > Lorem< / span > < span class = "nx" > ipsum< / span > < span class = "nx" > dolor< / span > < span class = "nx" > sit< / span > < span class = "nx" > amet< / span > < span class = "p" > ,< / span > < span class = "nx" > graecis< / span > < span class = "nx" > denique< / span > < span class = "nx" > ei< / span > < span class = "nx" > vel< / span > < span class = "p" > ,< / span > < span class = "nx" > at< / span > < span class = "nx" > duo< / span > < span class = "nx" > primis< / span > < span class = "nx" > mandamus< / span > < span class = "p" > .< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " rocket" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Et< / span > < span class = "nx" > legere< / span > < span class = "nx" > ocurreret< / span > < span class = "nx" > pri< / span > < span class = "p" > ,< / span > < span class = "nx" > animal< / span > < span class = "nx" > tacimates< / span > < span class = "nx" > complectitur< / span > < span class = "nx" > ad< / span > < span class = "nx" > cum< / span > < span class = "p" > .< / span > < span class = "nx" > Cu< / span > < span class = "nx" > eum< / span > < span class = "nx" > inermis< / span > < span class = "nx" > inimicus< / span > < span class = "nx" > efficiendi< / span > < span class = "p" > .< / span > < span class = "nx" > Labore< / span > < span class = "nx" > officiis< / span > < span class = "nx" > his< / span > < span class = "nx" > ex< / span > < span class = "p" > ,< / span > < span class = "nx" > soluta< / span > < span class = "nx" > officiis< / span > < span class = "nx" > concludaturque< / span > < span class = "nx" > ei< / span > < span class = "nx" > qui< / span > < span class = "p" > ,< / span > < span class = "nx" > vide< / span > < span class = "nx" > sensibus< / span > < span class = "nx" > vim< / span > < span class = "nx" > ad< / span > < span class = "p" > .< / span >
< / span > < / span > < / code > < / pre > < / div > < p > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. < span class = "badge cstyle blue badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-rocket" > < / i > < / span > < span class = "badge-content" > Awesome< / span > < / span > 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 >
< footer class = "footline" >
< / footer >
< / article >
< article class = "default" >
< h1 id = "button" > Button< / h1 >
2023-01-24 22:59:44 +00:00
< p > Th' < code > button< / code > shortcode displays a click'ble button wit' adjust'ble color, title an' ay'con.< / p >
2022-05-29 21:00:53 +00:00
< p >
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle warning" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-dragon" > < / i >
Get Cap'n Hugo
< / a >
< / span > < / p >
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.< / p >
2022-06-22 22:08:50 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " dragon" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/button.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " href" < / span > < span class = "s" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Get Hugo" < / 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 class = "nx" > partial< / span > < span class = "s" > " shortcodes/button.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " href" < / span > < span class = "s" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " style" < / span > < span class = "s" > " warning" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " dragon" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Get Hugo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< p > Once th' button be clicked, it opens another browser tab fer th' given URL.< / p >
2022-06-05 17:32:37 +00:00
< h3 id = "parameter" > Parameter< / h3 >
2022-05-29 21:00:53 +00:00
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > href< / strong > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-11-28 17:44:03 +00:00
< td style = "text-align:left" > Either th' destinat'n URL fer th' button or JavaScript code t' be executed on click. If this parameter be not set, th' button will do noth'n but be still displayed as click'ble.< br > < br > - if start'n wit' < code > javascript:< / code > all follow'n text will be executed 'n yer browser< br > - every other str'n will be interpreted as URL< / td >
2022-05-29 21:00:53 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > style< / strong > < / td >
< td style = "text-align:left" > < code > transparent< / code > < / td >
2023-01-23 23:14:54 +00:00
< td style = "text-align:left" > Th' style scheme used fer th' button.< br > < br > - by severity: < code > info< / code > , < code > note< / code > , < code > tip< / code > , < code > warning< / code > < br > - by brand color: < code > primary< / code > , < code > secondary< / code > , < code > accent< / code > < br > - by color: < code > blue< / code > , < code > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > < / td >
2023-01-23 22:49:15 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > color< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > Th' < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > t' be used. If not set, th' chosen color depends on th' < strong > style< / strong > . Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n color fer th' severity< br > - fer all other styles: th' correspond'n color< / td >
2022-05-29 21:00:53 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > ay'con< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > < a href = "../shortcodes/icon/#finding-an-icon" > Font Awesome ay'con name< / a > set t' th' left o' th' title. Depend'n on th' < strong > style< / strong > there may be a default ay'con. Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n ay'con fer th' severity< br > - fer all other styles: < em > < empty> < / em > < br > < br > If ye want no ay'con fer a severity style, ye have t' set this parameter t' < code > " " < / code > (a non empty str'n filled wit' spaces)< / td >
2022-05-29 21:00:53 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > iconposit'n< / strong > < / td >
< td style = "text-align:left" > < code > left< / code > < / td >
< td style = "text-align:left" > Places th' ay'con t' th' < code > left< / code > or < code > right< / code > o' th' title.< / td >
< / tr >
< tr >
2022-10-31 20:10:53 +00:00
< td style = "text-align:left" > < strong > target< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2022-12-26 01:09:01 +00:00
< td style = "text-align:left" > Th' destinat'n frame/window if < strong > href< / strong > be an URL. Otherwise th' parameter be not used. This behaves similar t' normal links. If th' parameter be not given it defaults t':< br > < br > - th' sett'n o' < code > externalLinkTarget< / code > or < code > _blank< / code > if not set, fer any address start'n wit' < code > http://< / code > or < code > https://< / code > < br > - no specific value fer all other links< / td >
2022-11-28 17:44:03 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > type< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2022-12-23 11:24:54 +00:00
< td style = "text-align:left" > Th' < a href = "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type" target = "_blank" > button type< / a > if < strong > href< / strong > be JavaScript. Otherwise th' parameter be not used. If th' parameter be not given it defaults t' < code > button< / code > < / td >
2022-10-31 20:10:53 +00:00
< / tr >
< tr >
2022-05-29 21:00:53 +00:00
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > Arbitrary text fer th' button title. Depend'n on th' < strong > style< / strong > there may be a default title. Any given value will overwrite th' default.< br > < br > - fer severity styles: th' match'n title fer th' severity< br > - fer all other styles: < em > < empty> < / em > < br > < br > If ye want no title fer a severity style, ye have t' set this parameter t' < code > " " < / code > (a non empty str'n filled wit' spaces)< / td >
2022-05-29 21:00:53 +00:00
< / tr >
< / tbody >
< / table >
< h2 id = "examples" > Examples< / h2 >
< h3 id = "style" > Style< / h3 >
2022-06-05 17:32:37 +00:00
< h4 id = "by-severity" > By Severity< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " note" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " tip" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle info" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-info-circle" > < / i >
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle note" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-exclamation-circle" > < / i >
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle tip" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-lightbulb" > < / i >
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle warning" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-exclamation-triangle" > < / i >
Get Cap'n Hugo
< / a >
< / span > < / p >
2022-06-05 17:32:37 +00:00
< h4 id = "by-brand-colors" > By Brand Colors< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " secondary" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2023-01-23 23:14:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " accent" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div > < p >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle primary" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle secondary" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
2023-01-23 23:14:54 +00:00
< / span >
< span class = "btn cstyle accent" >
< a href = "https://gohugo.io/" target = "_blank" >
Get Cap'n Hugo
< / a >
2022-05-29 21:00:53 +00:00
< / span > < / p >
2022-06-05 17:32:37 +00:00
< h4 id = "by-color" > By Color< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " green" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " grey" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " orange" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle blue" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle green" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle grey" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle orange" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle red" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
< / span > < / p >
2022-06-05 17:32:37 +00:00
< h4 id = "by-special-color" > By Special Color< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " default" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " transparent" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle default" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
< / span >
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Cap'n Hugo
< / a >
< / span > < / p >
< h3 id = "icon" > Ay'con< / h3 >
2022-06-05 17:32:37 +00:00
< h4 id = "to-the-left" > T' th' Left< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " download" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-download" > < / i >
Get Cap'n Hugo
< / a >
< / span >
2022-06-05 17:32:37 +00:00
< h4 id = "to-the-right" > T' th' Right< / h4 >
2022-06-23 11:25:28 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " download" < / span > < span class = "nx" > iconposit'n< / span > < span class = "p" > =< / span > < span class = "s" > " right" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-06-22 22:08:50 +00:00
Get Cap'n Hugo
2022-06-23 11:25:28 +00:00
< i class = "fa-fw fas fa-download" > < / i >
2022-05-29 21:00:53 +00:00
< / a >
< / span >
< h4 id = "override-for-severity" > Override fer Severity< / h4 >
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " dragon" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle warning" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-dragon" > < / i >
Get Cap'n Hugo
< / a >
< / span >
2022-10-31 20:10:53 +00:00
< h3 id = "target" > Target< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > target< / span > < span class = "p" > =< / span > < span class = "s" > " _self" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "nx" > 'n< / span > < span class = "nx" > same< / span > < span class = "nx" > window< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "nx" > 'n< / span > < span class = "nx" > new< / span > < span class = "nx" > Window< / span > < span class = "o" > /< / span > < span class = "nf" > Frame< / span > < span class = "p" > (< / span > < span class = "k" > default< / span > < span class = "p" > ){{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p >
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_self" >
2022-10-31 20:10:53 +00:00
Get Cap'n Hugo 'n same Window/Frame
< / a >
< / span >
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-10-31 20:10:53 +00:00
Get Cap'n Hugo 'n new Window/Frame (default)
< / a >
< / span > < / p >
2022-05-29 21:00:53 +00:00
< h3 id = "other" > Other< / h3 >
2023-01-23 22:49:15 +00:00
< h4 id = "with-user-defined-color-and-font-awesome-brand-icon" > Wit' User-Defined Color an' Font Awesome Brand Ay'con< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Cap'n Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< span class = "btn cstyle default" style = "--VARIABLE-BOX-color: fuchsia;" >
< a href = "https://gohugo.io/" target = "_blank" >
< i class = "fab fa-hackerrank" > < / i >
Cap'n Hugo
< / a >
< / span >
2022-11-28 17:44:03 +00:00
< h4 id = "severity-style-with-all-defaults" > Severity Style wit' All Defaults< / h4 >
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " tip" < / span > < span class = "o" > %< / span > < span class = "p" > }}{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle tip" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-lightbulb" > < / i >
Smarrrt Arrrse
< / a >
< / span >
2022-11-28 17:44:03 +00:00
< h4 id = "button-to-internal-page" > Button t' Internal Plank< / h4 >
2023-01-23 12:45:44 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " /index.html" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Home< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-10-31 20:10:53 +00:00
< / span > < / span > < / code > < / pre > < / div >
< span class = "btn cstyle transparent" >
2023-01-23 12:45:44 +00:00
< a href = "../index.html" >
2022-10-31 20:10:53 +00:00
Home
< / a >
< / span >
2022-11-28 17:44:03 +00:00
< h4 id = "button-with-javascript-action" > Button wit' JavaScript Act'n< / h4 >
< p > If yer JavaScript act'n does not change th' focus afterwards, make sure t' call < code > this.blur()< / code > 'n th' end t' unselect th' button.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " bullhorn" < / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " javascript:alert(' Hello world!' );this.blur();" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Shout< / span > < span class = "nx" > it< / span > < span class = "nx" > out< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< span class = "btn cstyle primary" >
< button onclick = "alert('Hello world!');this.blur();" type = "button" >
< i class = "fa-fw fas fa-bullhorn" > < / i >
Shout it out
< / button >
< / span >
< h4 id = "button-within-a-form-element" > Button within a < code > form< / code > Element< / h4 >
< p > T' use native HTML elements 'n yer Marrrkdown, add this 'n yer < code > config.toml< / code > < / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > marrrkup< / span > < span class = "p" > .< / span > < span class = "nx" > goldmark< / span > < span class = "p" > .< / span > < span class = "nx" > renderer< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > unsafe< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < / code > < / pre > < / div > < div class = "highlight" > < 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" > form< / span > < span class = "na" > act'n< / span > < span class = "o" > =< / span > < span class = "s" > " ../../search.html" < / span > < span class = "na" > method< / span > < span class = "o" > =< / span > < span class = "s" > " get" < / span > < span class = "p" > > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > < < / span > < span class = "nt" > input< / span > < span class = "na" > name< / span > < span class = "o" > =< / span > < span class = "s" > " search-by-detail" < / span > < span class = "na" > class< / span > < span class = "o" > =< / span > < span class = "s" > " search-by" < / span > < span class = "na" > type< / span > < span class = "o" > =< / span > < span class = "s" > " search" < / span > < span class = "p" > > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > {{% button type=" submit" style=" secondary" icon=" search" %}}Search{{% /button %}}
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > < /< / span > < span class = "nt" > form< / span > < span class = "p" > > < / span >
< / span > < / span > < / code > < / pre > < / div > < form action = "../../search.html" method = "get" >
< div class = "searchform" style = "width: 20vw;" >
< input name = "search-by-detail" class = "search-by" type = "search" placeholder = "Search..." >
< span class = "btn cstyle secondary" >
< button type = "submit" >
< i class = "fa-fw fas fa-search" > < / i >
Search
< / button >
< / span >
< / div >
< / form >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "children" > Children< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2023-01-24 22:59:44 +00:00
< p > Th' < code > children< / code > shortcode lists th' child planks o' th' current plank an' its descendants.< / p >
2022-06-22 22:08:50 +00:00
< ul class = "children children-li children-sort-weight" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/test/index.html" > plank X< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/index.html" > plank 1< / a > < / li >
< li > < a href = "../shortcodes/children/children-2/index.html" > plank 2< / a > < / li >
< li > < a href = "../shortcodes/children/children-3/index.html" > plank 3< / a > < / li >
2022-06-22 22:08:50 +00:00
< / ul >
2022-04-02 13:30:16 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.< / p >
2022-06-22 22:08:50 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "nx" > sort< / span > < span class = "p" > =< / span > < span class = "s" > " weight" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/children.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " sort" < / span > < span class = "s" > " weight" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
2022-04-02 13:30:16 +00:00
< table >
< thead >
< tr >
2022-06-05 17:32:37 +00:00
< th style = "text-align:left" > Name< / th >
2022-04-02 13:30:16 +00:00
< th style = "text-align:left" > Default< / th >
2022-06-05 17:32:37 +00:00
< th style = "text-align:left" > Notes< / th >
2022-04-02 13:30:16 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > containerstyle< / strong > < / td >
< td style = "text-align:left" > < code > ul< / code > < / td >
< td style = "text-align:left" > Choose th' style used t' group all children. It could be any HTML tag name.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > style< / strong > < / td >
< td style = "text-align:left" > < code > li< / code > < / td >
< td style = "text-align:left" > Choose th' style used t' display each descendant. It could be any HTML tag name.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > showhidden< / strong > < / td >
< td style = "text-align:left" > < code > false< / code > < / td >
2022-10-31 14:06:51 +00:00
< td style = "text-align:left" > When < code > true< / code > , child planks hidden from th' menu will be displayed as well.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > descript'n< / strong > < / td >
< td style = "text-align:left" > < code > false< / code > < / td >
2022-12-23 11:24:54 +00:00
< td style = "text-align:left" > When < code > true< / code > shows a short text under each plank 'n th' list. When no descript'n or summary exists fer th' plank, th' first 70 words o' th' rrrambl'n be taken - < a href = "https://gohugo.io/content/summaries/" target = "_blank" > read more info about summaries on gohugo.io< / a > .< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > depth< / strong > < / td >
< td style = "text-align:left" > < code > 1< / code > < / td >
2023-01-24 22:59:44 +00:00
< td style = "text-align:left" > Th' depth o' descendants t' display. For example, if th' value be < code > 2< / code > , th' shortcode will display two levels o' child planks. T' get all descendants, set this value t' a high number eg. < code > 999< / code > .< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > sort< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2022-12-16 17:42:17 +00:00
< td style = "text-align:left" > Th' sort order o' th' displayed list.< br > < br > If not set it be sorted by th' < a href = "../basics/configuration/#global-site-parameters" > < code > ordersectionsby< / code > < / a > sett'n o' th' ship an' th' planks frontmatter< br > < br > - < code > weight< / code > : t' sort on menu order< br > - < code > title< / code > : t' sort alphabetically on menu label.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< / tbody >
< / table >
2022-06-05 17:32:37 +00:00
< h2 id = "examples" > Examples< / h2 >
< h3 id = "all-default" > All Default< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/test/index.html" > plank X< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/index.html" > plank 1< / a > < / li >
< li > < a href = "../shortcodes/children/children-2/index.html" > plank 2< / a > < / li >
< li > < a href = "../shortcodes/children/children-3/index.html" > plank 3< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2022-06-05 17:32:37 +00:00
< h3 id = "with-description" > Wit' Descript'n< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "nx" > descript'n< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/test/index.html" > plank X< / a > < p > This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...
2022-10-07 18:46:19 +00:00
< / p > < / li >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-1/index.html" > plank 1< / a > < p > This be a demo child plank< / p > < / li >
< li > < a href = "../shortcodes/children/children-2/index.html" > plank 2< / a > < p > This be a demo child plank wit' no descript'n.
2022-10-07 18:46:19 +00:00
So its rrrambl'n be used as descript'n.< / p > < / li >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-3/index.html" > plank 3< / a > < p > This be a demo child plank< / p > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2022-10-31 14:06:51 +00:00
< h3 id = "infinite-depth-and-hidden-pages" > Infinite Depth an' Hidden Planks< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "nx" > depth< / span > < span class = "p" > =< / span > < span class = "s" > " 999" < / span > < span class = "nx" > showhidden< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/test/index.html" > plank X< / a > < ul >
< / ul > < / li >
< li > < a href = "../shortcodes/children/children-1/index.html" > plank 1< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/index.html" > plank 1-1< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html" > plank 1-1-1 (hidden)< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html" > plank 1-1-1-1< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html" > plank 1-1-1-1-1 (hidden)< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html" > plank 1-1-1-1-1-1< / a > < ul >
< / ul > < / li > < / ul > < / li > < / ul > < / li > < / ul > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" > plank 1-1-2< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html" > plank 1-1-2-1< / a > < ul >
< / ul > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html" > plank 1-1-2-2< / a > < ul >
< / ul > < / li > < / ul > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" > plank 1-1-3< / a > < ul >
< / ul > < / li > < / ul > < / li > < / ul > < / li >
< li > < a href = "../shortcodes/children/children-2/index.html" > plank 2< / a > < ul >
< / ul > < / li >
< li > < a href = "../shortcodes/children/children-3/index.html" > plank 3< / a > < ul >
< li > < a href = "../shortcodes/children/children-3/test3/index.html" > plank 3-1< / a > < ul >
< / ul > < / li > < / ul > < / li >
< li > < a href = "../shortcodes/children/children-4/index.html" > plank 4 (hidden)< / a > < ul >
< / ul > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2022-06-05 17:32:37 +00:00
< h3 id = "heading-styles-for-container-and-elements" > Head'n Styles fer Container an' Elements< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "nx" > containerstyle< / span > < span class = "p" > =< / span > < span class = "s" > " div" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " h2" < / span > < span class = "nx" > depth< / span > < span class = "p" > =< / span > < span class = "s" > " 3" < / span > < span class = "nx" > descript'n< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "children children-h2 children-sort-" >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/children/test/index.html" > plank X< / a > < / h2 > < p > This be a plain plank test, an' th' beginn'n o' a YAML multiline descript'n...
2022-06-23 18:04:40 +00:00
< / p >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/children/children-1/index.html" > plank 1< / a > < / h2 > < p > This be a demo child plank< / p >
< h3 > < a href = "../shortcodes/children/children-1/children-1-1/index.html" > plank 1-1< / a > < / h3 > < p > This be a demo child plank< / p >
< h4 > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" > plank 1-1-2< / a > < / h4 > < p > This be a demo child plank< / p >
< h4 > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" > plank 1-1-3< / a > < / h4 > < p > This be a demo child plank< / p >
< h2 > < a href = "../shortcodes/children/children-2/index.html" > plank 2< / a > < / h2 > < p > This be a demo child plank wit' no descript'n.
2022-06-23 18:04:40 +00:00
So its rrrambl'n be used as descript'n.< / p >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/children/children-3/index.html" > plank 3< / a > < / h2 > < p > This be a demo child plank< / p >
< h3 > < a href = "../shortcodes/children/children-3/test3/index.html" > plank 3-1< / a > < / h3 > < p > This be a plain plank test nested 'n a parent< / p >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "divs-for-group-and-element-styles" > Divs fer Group an' Element Styles< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "nx" > containerstyle< / span > < span class = "p" > =< / span > < span class = "s" > " div" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " div" < / span > < span class = "nx" > depth< / span > < span class = "p" > =< / span > < span class = "s" > " 3" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "children children-div children-sort-" >
2022-11-08 14:43:28 +00:00
< div > < a href = "../shortcodes/children/test/index.html" > plank X< / a > < / div >
< div > < a href = "../shortcodes/children/children-1/index.html" > plank 1< / a > < / div >
< div > < a href = "../shortcodes/children/children-1/children-1-1/index.html" > plank 1-1< / a > < / div >
< div > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" > plank 1-1-2< / a > < / div >
< div > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" > plank 1-1-3< / a > < / div >
< div > < a href = "../shortcodes/children/children-2/index.html" > plank 2< / a > < / div >
< div > < a href = "../shortcodes/children/children-3/index.html" > plank 3< / a > < / div >
< div > < a href = "../shortcodes/children/children-3/test3/index.html" > plank 3-1< / a > < / div >
2022-04-02 13:30:16 +00:00
< / div >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsct' ns o' Children< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-x" > Plank X< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This be a plain demo child plank.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-1" > Plank 1< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This be a demo child plank.< / p >
< h2 id = "subpages-of-this-page" > Subpages o' this plank< / h2 >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-1/children-1-1/index.html" > plank 1-1< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsct' ns o' Plank 1< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-1-1" > Plank 1-1< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-12-16 17:42:17 +00:00
< p > This be a demo child plank wit' a hidden child. Ye can still access th' hidden child < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/" > directly< / a > or via th' search.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "subpages-of-this-page" > Subpages o' this plank< / h2 >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html" > plank 1-1-1 (hidden)< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" > plank 1-1-2< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" > plank 1-1-3< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsct' ns o' Plank 1-1< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-1-1-2" > Plank 1-1-2< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This be a plain demo child plank.< / p >
< h2 id = "subpages-of-this-page" > Subpages o' this plank< / h2 >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html" > plank 1-1-2-1< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html" > plank 1-1-2-2< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsct' ns o' Plank 1-1-2< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-1-1-2-1" > Plank 1-1-2-1< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This be a plain demo child plank.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-1-1-2-2" > Plank 1-1-2-2< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This be a plain demo child plank.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< / section >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-1-1-3" > Plank 1-1-3< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This be a plain demo child plank.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< / section >
< / section >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-2" > Plank 2< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This be a demo child plank wit' no descript'n.< / p >
< p > So its rrrambl'n be used as descript'n.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-3" > Plank 3< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This be a demo child plank.< / p >
< h2 id = "subpages-of-this-page" > Subpages o' this plank< / h2 >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-3/test3/index.html" > plank 3-1< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsct' ns o' Plank 3< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "plank-3-1" > Plank 3-1< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This be a plain demo child plank.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< / section >
< / section >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "expand" > Expand< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2023-01-24 22:59:44 +00:00
< p > Th' < code > expand< / code > shortcode displays an expandable/collaps'ble section o' text.< / p >
2022-04-02 13:30:16 +00:00
< div class = "expand" >
2023-02-10 23:05:55 +00:00
< input type = "checkbox" id = "expand-e42de4c9642eb1c1b515e095d31e81bd" aria-controls = "expandcontent-e42de4c9642eb1c1b515e095d31e81bd" >
< label class = "expand-label" for = "expand-e42de4c9642eb1c1b515e095d31e81bd" >
2022-04-02 13:30:16 +00:00
< i class = "fas fa-chevron-down" > < / i >
2023-02-09 00:02:54 +00:00
< i class = "fas fa-chevron-right" > < / i >
2022-06-05 17:32:37 +00:00
Expand me...
2023-02-03 07:58:48 +00:00
< / label >
2023-02-10 23:05:55 +00:00
< div id = "expandcontent-e42de4c9642eb1c1b515e095d31e81bd" class = "expand-content" >
2022-06-05 17:32:37 +00:00
Thank ye!
< / div >
< / div >
2023-02-03 07:58:48 +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" >
2023-02-04 15:02:34 +00:00
< p > This only works 'n modern browsers flawlessly. While Internet Explorer 11 has issues 'n display'n it, th' functionality still works.< / p >
2023-02-03 07:58:48 +00:00
< / div >
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.< / p >
2022-04-02 13:30:16 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > expand< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Expand me..." < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Thank< / span > < span class = "nx" > ye< / span > < span class = "p" > !{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > expand< / span > < span class = "s" > " Expand me..." < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Thank< / span > < span class = "nx" > ye< / span > < span class = "p" > !{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/expand.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " title" < / span > < span class = "s" > " Expand me..." < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Thank ye!" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Posit'n< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > title< / strong > < / td >
< td style = "text-align:left" > 1< / td >
< td style = "text-align:left" > < code > " Expand me..." < / code > < / td >
2022-10-31 14:06:51 +00:00
< td style = "text-align:left" > Arbitrary text t' appear next t' th' expand/collapse ay'con.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > open< / strong > < / td >
< td style = "text-align:left" > 2< / td >
< td style = "text-align:left" > < code > false< / code > < / td >
< td style = "text-align:left" > When < code > true< / code > th' rrrambl'n text will be initially shown as expanded.< / td >
< / tr >
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-10-31 14:06:51 +00:00
< td style = "text-align:left" > Arbitrary text t' be displayed on expand.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< / tbody >
< / table >
< h2 id = "examples" > Examples< / h2 >
< h3 id = "all-defaults" > All Defaults< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Yes< / span > < span class = "p" > ,< / span > < span class = "nx" > ye< / span > < span class = "nx" > did< / span > < span class = "nx" > it< / span > < span class = "p" > !{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-04-02 13:30:16 +00:00
< div class = "expand" >
2023-02-10 23:05:55 +00:00
< input type = "checkbox" id = "expand-ec0040982a252baff74612e0f0f0fbd9" aria-controls = "expandcontent-ec0040982a252baff74612e0f0f0fbd9" >
< label class = "expand-label" for = "expand-ec0040982a252baff74612e0f0f0fbd9" >
2022-04-02 13:30:16 +00:00
< i class = "fas fa-chevron-down" > < / i >
2023-02-09 00:02:54 +00:00
< i class = "fas fa-chevron-right" > < / i >
2022-04-02 13:30:16 +00:00
Expand me...
2023-02-03 07:58:48 +00:00
< / label >
2023-02-10 23:05:55 +00:00
< div id = "expandcontent-ec0040982a252baff74612e0f0f0fbd9" class = "expand-content" >
2022-06-05 17:32:37 +00:00
Yes, ye did it!
2022-04-02 13:30:16 +00:00
< / div >
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "initially-expanded" > Initially Expanded< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > expand< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Expand me..." < / span > < span class = "nx" > open< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > No< / span > < span class = "nx" > need< / span > < span class = "nx" > t'< / span > < span class = "nx" > press< / span > < span class = "nx" > ye< / span > < span class = "p" > !{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div >
2023-02-03 07:58:48 +00:00
< div class = "expand" >
2023-02-10 23:05:55 +00:00
< input type = "checkbox" id = "expand-8d1f0f30b7b4c7dbc3e00dc1590212f6" aria-controls = "expandcontent-8d1f0f30b7b4c7dbc3e00dc1590212f6" checked >
< label class = "expand-label" for = "expand-8d1f0f30b7b4c7dbc3e00dc1590212f6" >
2022-04-02 13:30:16 +00:00
< i class = "fas fa-chevron-down" > < / i >
2023-02-09 00:02:54 +00:00
< i class = "fas fa-chevron-right" > < / i >
2022-04-02 13:30:16 +00:00
Expand me...
2023-02-03 07:58:48 +00:00
< / label >
2023-02-10 23:05:55 +00:00
< div id = "expandcontent-8d1f0f30b7b4c7dbc3e00dc1590212f6" class = "expand-content" >
2022-06-05 17:32:37 +00:00
No need t' press ye!
2022-04-02 13:30:16 +00:00
< / div >
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "arbitrary-text" > Arbitrary Text< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > expand< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Show me almost endless possibilities" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Ye< / span > < span class = "nx" > can< / span > < span class = "nx" > add< / span > < span class = "nx" > standard< / span > < span class = "nx" > markdown< / span > < span class = "nx" > rules< / span > < span class = "p" > :< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > multiple< / span > < span class = "nx" > paragraphs< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > bullet< / span > < span class = "nx" > point< / span > < span class = "nx" > lists< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > _emphasized_< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "nx" > bold< / span > < span class = "o" > **< / span > < span class = "nx" > an'< / span > < span class = "nx" > even< / span > < span class = "o" > **< / span > < span class = "nx" > _bold< / span > < span class = "nx" > emphasized_< / span > < span class = "o" > **< / span > < span class = "nx" > text< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "p" > [< / span > < span class = "nx" > links< / span > < span class = "p" > ](< / span > < span class = "nx" > https< / span > < span class = "p" > :< / span > < span class = "c1" > //example.com)
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c1" > < / span > < span class = "o" > -< / span > < span class = "nx" > etc< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```plaintext
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ...and even source code
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-10-31 14:06:51 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > > < / span > < span class = "nx" > th'< / span > < span class = "nx" > possibilities< / span > < span class = "nx" > be< / span > < span class = "nf" > endless< / span > < span class = "p" > (< / span > < span class = "nx" > almost< / span > < span class = "o" > -< / span > < span class = "nx" > includ'n< / span > < span class = "nx" > other< / span > < span class = "nx" > shorrrtcodes< / span > < span class = "nx" > may< / span > < span class = "nx" > or< / span > < span class = "nx" > may< / span > < span class = "nx" > not< / span > < span class = "nx" > work< / span > < span class = "p" > )< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "expand" >
2023-02-10 23:05:55 +00:00
< input type = "checkbox" id = "expand-f2ae19598f56499572995ad803363270" aria-controls = "expandcontent-f2ae19598f56499572995ad803363270" >
< label class = "expand-label" for = "expand-f2ae19598f56499572995ad803363270" >
2022-04-02 13:30:16 +00:00
< i class = "fas fa-chevron-down" > < / i >
2023-02-09 00:02:54 +00:00
< i class = "fas fa-chevron-right" > < / i >
2022-05-23 13:00:05 +00:00
Show me almost endless possibilities
2023-02-03 07:58:48 +00:00
< / label >
2023-02-10 23:05:55 +00:00
< div id = "expandcontent-f2ae19598f56499572995ad803363270" class = "expand-content" >
2022-05-23 13:00:05 +00:00
< p > Ye can add standard markdown rules:< / p >
2022-04-02 13:30:16 +00:00
< ul >
< li > multiple paragraphs< / li >
< li > bullet point lists< / li >
< li > < em > emphasized< / em > , < strong > bold< / strong > an' even < strong > < em > bold emphasized< / em > < / strong > text< / li >
2022-12-23 11:24:54 +00:00
< li > < a href = "https://example.com" target = "_blank" > links< / a > < / li >
2022-04-02 13:30:16 +00:00
< li > etc.< / li >
< / ul >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ...and even source code
< / span > < / span > < / code > < / pre > < / div > < blockquote >
2022-10-31 14:06:51 +00:00
< p > th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)< / p >
2022-04-02 13:30:16 +00:00
< / blockquote >
< / div >
< / div >
< footer class = "footline" >
< / footer >
< / article >
2022-12-02 17:32:53 +00:00
< article class = "default" >
< h1 id = "icon" > Icon< / h1 >
2023-01-24 22:59:44 +00:00
< p > Th' < code > ay'con< / code > shortcode displays ay'cons us'n th' < a href = "https://fontawesome.com" target = "_blank" > Font Awesome< / a > library.< / p >
2022-12-02 17:32:53 +00:00
< p >
< i class = "fa-fw fas fa-exclamation-triangle" > < / i >
< i class = "fa-fw fas fa-angle-double-up" > < / i >
< i class = "fa-fw fas fa-skull-crossbones" > < / i > < / p >
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' positional parameter ye be free t' also call this shortcode from yer own partials.< / p >
2022-12-02 17:32:53 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-12-02 17:32:53 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-12-02 17:32:53 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-12-02 17:32:53 +00:00
< button
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-12-02 17:32:53 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-12-02 17:32:53 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-12-02 17:32:53 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-12-02 17:32:53 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-12-02 17:32:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " exclamation-triangle" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " skull-crossbones" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-12-02 17:32:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > exclamat'n< / span > < span class = "o" > -< / span > < span class = "nx" > triangle< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > angle< / span > < span class = "o" > -< / span > < span class = "nx" > do'ble< / span > < span class = "o" > -< / span > < span class = "nx" > up< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > skull< / span > < span class = "o" > -< / span > < span class = "nx" > crossbones< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-12-02 17:32:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/icon.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " exclamation-triangle" < / 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 class = "nx" > partial< / span > < span class = "s" > " shortcodes/icon.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " angle-double-up" < / 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 class = "nx" > partial< / span > < span class = "s" > " shortcodes/icon.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " skull-crossbones" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Posit'n< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > ay'con< / strong > < / td >
< td style = "text-align:left" > 1< / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-12-16 17:42:17 +00:00
< td style = "text-align:left" > < a href = "#finding-an-icon" > Font Awesome ay'con name< / a > t' be displayed. It will be displayed 'n th' text color o' its accord'n context.< / td >
2022-12-02 17:32:53 +00:00
< / tr >
< / tbody >
< / table >
2022-12-02 18:27:40 +00:00
< h3 id = "finding-an-icon" > Find'n an ay'con< / h3 >
2022-12-23 11:24:54 +00:00
< p > Browse through th' avail'ble ay'cons 'n th' < a href = "https://fontawesome.com/v5/search?m=free" target = "_blank" > Font Awesome Gallery< / a > . Notice that th' < strong > free< / strong > filter be enabled, as only th' free ay'cons be avail'ble by default.< / p >
< p > Once on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' < a href = "https://fontawesome.com/v5/icons/heart?s=solid" target = "_blank" > heart< / a > , copy th' ay'con name an' paste into th' Marrrkdown rrrambl'n.< / p >
2022-12-02 18:27:40 +00:00
< h3 id = "customising-icons" > Customis'n Ay'cons< / h3 >
2022-12-02 17:32:53 +00:00
< p > Font Awesome provides many ways t' modify th' ay'con< / p >
< ul >
< li > Change color (by default th' ay'con will inherit th' parent color)< / li >
< li > Increase or decrease size< / li >
< li > Rotate< / li >
< li > Combine wit' other ay'cons< / li >
< / ul >
2022-12-23 11:24:54 +00:00
< p > Check th' full documentat'n on < a href = "https://fontawesome.com/how-to-use/web-fonts-with-css" target = "_blank" > web fonts wit' CSS< / a > fer more.< / p >
2022-12-02 17:32:53 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-12-02 18:27:40 +00:00
< h3 id = "standard-usage" > Standard Usage< / h3 >
2022-12-02 17:32:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "nx" > Built< / span > < span class = "nx" > wit'< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > heart< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > by< / span > < span class = "nx" > Relearrrn< / span > < span class = "nx" > an'< / span > < span class = "nx" > Cap'n Hugo< / span >
< / span > < / span > < / code > < / pre > < / div > < p > Built wit'
< i class = "fa-fw fas fa-heart" > < / i > by Relearrrn an' Cap'n Hugo< / p >
< h3 id = "advanced-html-usage" > Advanced HTML Usage< / h3 >
2023-01-24 22:59:44 +00:00
< p > While th' shortcode simplyfies us'n standard ay'cons, th' ay'con customisat'n an' other advanced features o' th' Font Awesome library requires ye t' use HTML directly. Just paste th' < code > < i> < / code > HTML into marrrkup an' Font Awesome will board th' relevant ay'con.< / p >
2022-12-02 17:32:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-html" data-lang = "html" > < span class = "line" > < span class = "cl" > Built wit' < span class = "p" > < < / span > < span class = "nt" > i< / span > < span class = "na" > class< / span > < span class = "o" > =< / span > < span class = "s" > " fas fa-heart" < / span > < span class = "p" > > < /< / span > < span class = "nt" > i< / span > < span class = "p" > > < / span > by Relearrrn an' Cap'n Hugo
< / span > < / span > < / code > < / pre > < / div > < p > Built wit' < i class = "fas fa-heart" > < / i > by Relearrrn an' Cap'n Hugo< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "include" > Include< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2023-01-24 22:59:44 +00:00
< p > Th' < code > include< / code > shortcode includes other files from yer project inside o' th' current plank.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or also call this shortcode from yer own partials.< / p >
2022-06-05 17:32:37 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > include< / span > < span class = "nx" > file< / span > < span class = "p" > =< / span > < span class = "s" > " shortcodes/INCLUDE_ME.md" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > include< / span > < span class = "s" > " shortcodes/INCLUDE_ME.md" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/include .html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " file" < / span > < span class = "s" > " shortcodes/INCLUDE_ME.md" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< p > Th' included files can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.< / p >
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Posit'n< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > file< / strong > < / td >
< td style = "text-align:left" > 1< / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-12-23 11:24:54 +00:00
< td style = "text-align:left" > Th' path t' th' file t' be included. Path resolut'n adheres t' < a href = "https://gohugo.io/functions/readfile/" target = "_blank" > Hugo’ s build-in < code > readFile< / code > funct'n< / a > < / td >
2022-06-05 17:32:37 +00:00
< / tr >
< tr >
2022-06-23 11:25:28 +00:00
< td style = "text-align:left" > < strong > hidefirsthead'n< / strong > < / td >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > 2< / td >
2022-06-23 11:25:28 +00:00
< td style = "text-align:left" > < code > false< / code > < / td >
< td style = "text-align:left" > When < code > true< / code > an' th' included file contains head'ns, th' first head'n will be hidden. This comes 'n handy, eg. if ye include otherwise standalone Marrrkdown files.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< / tbody >
< / table >
2022-04-02 13:30:16 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-10-31 14:06:51 +00:00
< h3 id = "arbitrary-content" > Arbitrary Rrrambl'n< / h3 >
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > include< / span > < span class = "s" > " shortcodes/INCLUDE_ME.md" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-23 11:28:22 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > Ye can add standard markdown rules:< / p >
2022-04-02 13:30:16 +00:00
< ul >
< li > multiple paragraphs< / li >
< li > bullet point lists< / li >
< li > < em > emphasized< / em > , < strong > bold< / strong > an' even < strong > < em > bold emphasized< / em > < / strong > text< / li >
2022-12-23 11:24:54 +00:00
< li > < a href = "https://example.com" target = "_blank" > links< / a > < / li >
2022-04-02 13:30:16 +00:00
< li > etc.< / li >
< / ul >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ...and even source code
< / span > < / span > < / code > < / pre > < / div > < blockquote >
2022-10-31 14:06:51 +00:00
< p > th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work) (almost - includ'n other shorrrtcodes may or may not work)< / p >
2022-04-02 13:30:16 +00:00
< / blockquote >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "math" > Math< / h1 >
2022-07-02 12:20:53 +00:00
2022-07-05 22:16:52 +00:00
2022-07-02 12:20:53 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Arrr! Pirrrates< / div >
< div class = "box-content" >
2023-02-10 16:31:44 +00:00
< p > Fello' pirrrates, grog made us dizzy! Be awarrre < b > some stuff may not work< / b > in this trrranslat'n. Like see'n < b > Merrrmaids< / b > , do'n < b > math or chemistrrry< / b > , writ'n docs and stuff.< / p >
2022-12-04 10:37:18 +00:00
< / div >
2022-07-02 12:20:53 +00:00
< / div >
2023-01-24 22:59:44 +00:00
< p > Th' < code > math< / code > shortcode generates beautiful formatted math an' chemical formulae us'n th' < a href = "https://mathjax.org/" target = "_blank" > MathJax< / a > library.< / p >
2022-07-02 12:20:53 +00:00
< span class = "math align-center" >
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span >
2022-07-02 22:46:26 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-07-02 22:46:26 +00:00
< p > This only works 'n modern browsers.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-07-02 22:46:26 +00:00
< / div >
2022-07-02 12:20:53 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-10-04 13:36:17 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Math codefences (eg. GitHub) an' so yer markdown becomes more port'ble.< / p >
2023-01-24 22:59:44 +00:00
< p > Ye be free t' also call this shortcode from yer own partials.< / p >
2022-07-02 12:20:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-12-16 17:42:17 +00:00
< p > T' use codefence rules ye have t' turn off < code > guessSyntax< / code > fer th' < code > marrrkup.highlight< / code > sett'n (< a href = "#configuration" > see th' configurat'n section< / a > ).< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-07-02 12:20:53 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-07-02 12:20:53 +00:00
< div class = "tab-nav" >
< button
data-tab-item="codefence"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-07-02 12:20:53 +00:00
onclick="switchTab('shortcode-parameter','codefence')"
2023-01-29 16:05:10 +00:00
>
< span > codefence< / span > < / button >
2022-07-02 12:20:53 +00:00
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-07-02 12:20:53 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-07-02 12:20:53 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-07-02 12:20:53 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-07-02 12:20:53 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="codefence"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-10-31 14:31:20 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ```math { align=" center" }
< / span > < / span > < span class = "line" > < span class = "cl" > $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span > < / span > < span class = "line" > < span class = "cl" > ```
2022-07-02 12:20:53 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-10-31 14:31:20 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > math< / span > < span class = "nx" > align< / span > < span class = "p" > =< / span > < span class = "s" > " center" < / span > < span class = "p" > > }}< / span >
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > $$\< / span > < span class = "nf" > left< / span > < span class = "p" > (< / span > < span class = "err" > \< / span > < span class = "nx" > sum_< / span > < span class = "p" > {< / span > < span class = "nx" > k< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span > < span class = "p" > }^< / span > < span class = "nx" > n< / span > < span class = "nx" > a_k< / span > < span class = "nx" > b_k< / span > < span class = "err" > \< / span > < span class = "nx" > right< / span > < span class = "p" > )^< / span > < span class = "mi" > 2< / span > < span class = "err" > \< / span > < span class = "nx" > leq< / span > < span class = "err" > \< / span > < span class = "nf" > left< / span > < span class = "p" > (< / span > < span class = "err" > \< / span > < span class = "nx" > sum_< / span > < span class = "p" > {< / span > < span class = "nx" > k< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span > < span class = "p" > }^< / span > < span class = "nx" > n< / span > < span class = "nx" > a_k< / span > < span class = "p" > ^< / span > < span class = "mi" > 2< / span > < span class = "err" > \< / span > < span class = "nx" > right< / span > < span class = "p" > )< / span > < span class = "err" > \< / span > < span class = "nf" > left< / span > < span class = "p" > (< / span > < span class = "err" > \< / span > < span class = "nx" > sum_< / span > < span class = "p" > {< / span > < span class = "nx" > k< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span > < span class = "p" > }^< / span > < span class = "nx" > n< / span > < span class = "nx" > b_k< / span > < span class = "p" > ^< / span > < span class = "mi" > 2< / span > < span class = "err" > \< / span > < span class = "nx" > right< / span > < span class = "p" > )< / span > < span class = "err" > $$< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > math< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-07-02 12:20:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/math.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " $$left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$" < / span >
2022-10-31 14:31:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " align" < / span > < span class = "s" > " center" < / span >
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > align< / strong > < / td >
< td style = "text-align:left" > < code > center< / code > < / td >
< td style = "text-align:left" > Allowed values be < code > left< / code > , < code > center< / code > or < code > right< / code > .< / td >
< / tr >
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > Yer formuale.< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "configuration" > Configurat'n< / h2 >
< p > MathJax be configured wit' default sett'ns. Ye can cust'mize MathJax’ s default sett'ns fer all o' yer files thru a JSON object 'n yer < code > config.toml< / code > or override these sett'ns per plank thru yer planks frontmatter.< / p >
< p > Th' JSON object o' yer < code > config.toml< / code > / frontmatter be forwarded into MathJax’ s configurat'n object.< / p >
2022-12-23 11:24:54 +00:00
< p > See < a href = "https://docs.mathjax.org/en/latest/options/index.html" target = "_blank" > MathJax documentat'n< / a > fer all allowed sett'ns.< / p >
2022-07-02 12:20:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-07-02 12:20:53 +00:00
< p > T' use codefence rules ye have t' turn off < code > guessSyntax< / code > fer th' < code > marrrkup.highlight< / code > sett'n.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-07-02 12:20:53 +00:00
< / div >
< h3 id = "global-configuration-file" > Global Configurat'n File< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mathJaxInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" chtml\" : { \" displayAlign\" : \" left\" } }" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > marrrkup< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > marrrkup< / span > < span class = "p" > .< / span > < span class = "nx" > highlight< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # if `guessSyntax = true`, there will be no unstyled code even if no language< / span >
2022-10-04 13:36:17 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # mandatory sett'n fer yer ship if ye want t' use Math codefences< / span >
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > guessSyntax< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < / code > < / pre > < / div > < h3 id = "pages-frontmatter" > Page’ s Frontmatter< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mathJaxInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" chtml\" : { \" displayAlign\" : \" left\" } }" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < / code > < / pre > < / div > < h2 id = "examples" > Examples< / h2 >
< h3 id = "inline-math" > Inline Math< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > Inline math be generated if ye use a single < span class = "sb" > `$`< / span > as a delimiter around yer formulae: {{< span class = "p" > < < / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}$\sqrt{3}${{< span class = "p" > < < / span > < span class = "p" > /< / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}
< / span > < / span > < / code > < / pre > < / div > < p > Inline math be generated if ye use a single < code > $< / code > as a delimiter around yer formulae:
< span class = "math align-center" > $\sqrt{3}$< / span > < / p >
2022-11-05 12:01:19 +00:00
< h3 id = "blocklevel-math-with-right-alignment" > Blocklevel Math wit' Right Alignment< / h3 >
2022-07-02 12:20:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > If ye delimit yer formulae by two consecutive < span class = "sb" > `$$`< / span > it generates a new block.
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-11-05 12:01:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > {{< span class = "p" > < < / span > < span class = "nt" > math< / span > < span class = "na" > align< / span > < span class = "o" > =< / span > < span class = "s" > " right" < / span > < span class = "p" > > < / span > }}
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span > < / span > < span class = "line" > < span class = "cl" > {{< span class = "p" > < < / span > < span class = "p" > /< / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}
< / span > < / span > < / code > < / pre > < / div > < p > If ye delimit yer formulae by two consecutive < code > $$< / code > it generates a new block.< / p >
2022-11-05 12:01:19 +00:00
< span class = "math align-right" >
2022-07-02 12:20:53 +00:00
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span >
< h3 id = "codefence" > Codefence< / h3 >
2023-01-14 00:40:32 +00:00
< p > Ye can also use codefences.< / p >
2022-07-02 12:20:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > < span class = "s" > ```math
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > < / span > $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-07-02 22:36:23 +00:00
< span class = "math align-center" > $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$< / span > < h3 id = "chemical-formulae" > Chemical Formulae< / h3 >
2022-07-02 12:20:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > {{< span class = "p" > < < / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}
< / span > < / span > < span class = "line" > < span class = "cl" > $$\ce{Hg^2+ -> [I-] HgI2 -> [I-] [Hg^{II}I4]^2-}$$
< / span > < / span > < span class = "line" > < span class = "cl" > {{< span class = "p" > < < / span > < span class = "p" > /< / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}
< / span > < / span > < / code > < / pre > < / div >
< span class = "math align-center" >
$$\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}$$
< / span >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "merrrmaid" > Merrrmaid< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-05-29 22:03:12 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Arrr! Pirrrates< / div >
< div class = "box-content" >
2023-02-10 16:31:44 +00:00
< p > Fello' pirrrates, grog made us dizzy! Be awarrre < b > some stuff may not work< / b > in this trrranslat'n. Like see'n < b > Merrrmaids< / b > , do'n < b > math or chemistrrry< / b > , writ'n docs and stuff.< / p >
2022-12-04 10:37:18 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-01-24 22:59:44 +00:00
< p > Th' < code > mermaid< / code > shortcode generates diagrams an' flowcharts from text, 'n a similar manner as Marrrkdown us'n th' < a href = "https://mermaidjs.github.io/" target = "_blank" > Merrrmaid< / a > library.< / p >
2022-06-05 17:32:37 +00:00
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-06-05 17:32:37 +00:00
graph LR;
2022-10-07 18:46:19 +00:00
If --> Then
Then --> Else
2022-06-05 17:32:37 +00:00
< / div >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > This only works 'n modern browsers.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > Arrr< / div >
< div class = "box-content" >
2023-01-24 22:59:44 +00:00
< p > Due t' limitat'ns wit' < a href = "https://github.com/mermaid-js/mermaid/issues/1846" target = "_blank" > Merrrmaid< / a > , it be currently not poss'ble t' use Merrrmaid code fences 'n an initially collapsed < code > expand< / code > shortcode. This be a know issue an' < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/187" target = "_blank" > can’ t be fixed by this theme< / a > .< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter it be recommended t' use codefences instead. This be because more an' more other software supports Merrrmaid codefences (eg. GitHub) an' so yer markdown becomes more port'ble.< / p >
2023-01-24 22:59:44 +00:00
< p > Ye be free t' also call this shortcode from yer own partials.< / p >
2022-04-02 13:30:16 +00:00
2022-06-05 17:32:37 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-12-16 17:42:17 +00:00
< p > T' use codefence rules ye have t' turn off < code > guessSyntax< / code > fer th' < code > marrrkup.highlight< / code > sett'n (< a href = "#configuration" > see th' configurat'n section< / a > ).< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
data-tab-item="codefence"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','codefence')"
2023-01-29 16:05:10 +00:00
>
< span > codefence< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="codefence"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2023-02-05 10:13:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ```mermaid { align=" center" zoom=" true" }
2022-10-31 14:17:29 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > graph LR;
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > If --> Then
< / span > < / span > < span class = "line" > < span class = "cl" > Then --> Else
2022-10-31 14:17:29 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ```
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2023-02-05 10:13:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "nx" > align< / span > < span class = "p" > =< / span > < span class = "s" > " center" < / span > < span class = "nx" > zoom< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "p" > > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > graph< / span > < span class = "nx" > LR< / span > < span class = "p" > ;< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > If< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > Then< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Then< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > Else< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/mermaid.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " graph LR;\nIf --> Then\nThen --> Else" < / span >
2022-10-31 14:17:29 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " align" < / span > < span class = "s" > " center" < / span >
2023-02-05 10:13:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " zoom" < / span > < span class = "s" > " true" < / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2022-06-22 22:08:50 +00:00
< p > Th' generated graphs can be be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.< / p >
2022-06-05 17:32:37 +00:00
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > align< / strong > < / td >
< td style = "text-align:left" > < code > center< / code > < / td >
< td style = "text-align:left" > Allowed values be < code > left< / code > , < code > center< / code > or < code > right< / code > .< / td >
< / tr >
< tr >
2023-02-05 10:13:50 +00:00
< td style = "text-align:left" > < strong > zoom< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > Whether th' graph be pan- an' zoom'ble.< br > < br > If not set th' value be determined by th' < code > mermaidZoom< / code > sett'n o' th' < a href = "#global-configuration-file" > ship< / a > or th' < a href = "#pages-frontmatter" > planks frontmatter< / a > or < code > false< / code > if not set at all.< br > < br > - < code > false< / code > : no pan or zoom< br > - < code > true< / code > : pan an' zoom active< / td >
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-10-04 13:36:17 +00:00
< td style = "text-align:left" > Yer Merrrmaid graph.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< / tbody >
< / table >
< h2 id = "configuration" > Configurat'n< / h2 >
2022-12-23 11:24:54 +00:00
< p > Merrrmaid be configured wit' default sett'ns. Ye can cust'mize Mermaid’ s default sett'ns fer all o' yer files thru a JSON object 'n yer < code > config.toml< / code > , override these sett'ns per plank thru yer planks frontmatter or override these sett'n per diagramm thru < a href = "https://mermaid-js.github.io/mermaid/#/directives?id=directives" target = "_blank" > diagram directives< / a > .< / p >
2022-06-05 17:32:37 +00:00
< p > Th' JSON object o' yer < code > config.toml< / code > / frontmatter be forwarded into Mermaid’ s < code > mermaid.initialize()< / code > funct'n.< / p >
2022-12-23 11:24:54 +00:00
< p > See < a href = "https://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults" target = "_blank" > Merrrmaid documentat'n< / a > fer all allowed sett'ns.< / p >
2022-06-05 17:32:37 +00:00
< p > Th' < code > theme< / code > sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n < code > config.toml< / code > , frontmatter or diagram directives.< / p >
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-06-05 17:32:37 +00:00
< p > T' use codefence rules ye have t' turn off < code > guessSyntax< / code > fer th' < code > marrrkup.highlight< / code > sett'n.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< / div >
< h3 id = "global-configuration-file" > Global Configurat'n File< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" theme\" : \" dark\" }" < / span >
2023-02-05 10:13:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidZoom< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > marrrkup< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > marrrkup< / span > < span class = "p" > .< / span > < span class = "nx" > highlight< / span > < span class = "p" > ]< / span >
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # if `guessSyntax = true`, there will be no unstyled code even if no language< / span >
2022-10-04 13:36:17 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # was given BUT Merrrmaid an' Math codefences will not work anymore! So this be a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # mandatory sett'n fer yer ship if ye want t' use Merrrmaid codefences< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > guessSyntax< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < / code > < / pre > < / div > < h3 id = "pages-frontmatter" > Page’ s Frontmatter< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" theme\" : \" dark\" }" < / span >
2023-02-05 10:13:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidZoom< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < / code > < / pre > < / div > < h2 id = "examples" > Examples< / h2 >
< h3 id = "flowchart-with-non-default-mermaid-theme" > Flowchart wit' Non-Default Merrrmaid Theme< / h3 >
2022-11-05 12:01:19 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > %%< / span > < span class = "p" > {< / span > < span class = "nx" > init< / span > < span class = "p" > :{< / span > < span class = "s" > " theme" < / span > < span class = "p" > :< / span > < span class = "s" > " forest" < / span > < span class = "p" > }}< / span > < span class = "o" > %%< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > graph< / span > < span class = "nx" > LR< / span > < span class = "p" > ;< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "p" > [< / span > < span class = "nx" > Hard< / span > < span class = "nx" > edge< / span > < span class = "p" > ]< / span > < span class = "o" > --< / span > < span class = "p" > > |< / span > < span class = "nx" > Link< / span > < span class = "nx" > text< / span > < span class = "p" > |< / span > < span class = "nf" > B< / span > < span class = "p" > (< / span > < span class = "nx" > Round< / span > < span class = "nx" > edge< / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > B< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > C< / span > < span class = "p" > {< < / span > < span class = "nx" > strong< / span > < span class = "p" > > < / span > < span class = "nx" > Decision< / span > < span class = "p" > < < / span > < span class = "o" > /< / span > < span class = "nx" > strong< / span > < span class = "p" > > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > C< / span > < span class = "o" > --< / span > < span class = "p" > > |< / span > < span class = "nx" > One< / span > < span class = "p" > |< / span > < span class = "nx" > D< / span > < span class = "p" > [< / span > < span class = "nx" > Result< / span > < span class = "nx" > one< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > C< / span > < span class = "o" > --< / span > < span class = "p" > > |< / span > < span class = "nx" > Two< / span > < span class = "p" > |< / span > < span class = "nx" > E< / span > < span class = "p" > [< / span > < span class = "nx" > Result< / span > < span class = "nx" > two< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-10-07 18:46:19 +00:00
%%{init:{" theme" :" forest" }}%%
2022-06-05 17:32:37 +00:00
graph LR;
2022-10-07 18:46:19 +00:00
A[Hard edge] --> |Link text| B(Round edge)
B --> C{< strong> Decision< /strong> }
C --> |One| D[Result one]
C --> |Two| E[Result two]
2022-04-02 13:30:16 +00:00
< / div >
2022-11-18 23:02:20 +00:00
< h3 id = "sequence-diagram-with-configuration-directive" > Sequence Diagram wit' Configurat'n Directive< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > %%< / span > < span class = "p" > {< / span > < span class = "nx" > init< / span > < span class = "p" > :{< / span > < span class = "s" > " fontFamily" < / span > < span class = "p" > :< / span > < span class = "s" > " monospace" < / span > < span class = "p" > ,< / span > < span class = "s" > " sequence" < / span > < span class = "p" > :{< / span > < span class = "s" > " showSequenceNumbers" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > }}}< / span > < span class = "o" > %%< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > sequenceDiagram< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Alice< / span > < span class = "o" > -> > < / span > < span class = "nx" > John< / span > < span class = "p" > :< / span > < span class = "nx" > Hello< / span > < span class = "nx" > John< / span > < span class = "p" > ,< / span > < span class = "nx" > how< / span > < span class = "nx" > be< / span > < span class = "nx" > ye< / span > < span class = "err" > ?< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > loop< / span > < span class = "nx" > Healthcheck< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > John< / span > < span class = "o" > -> > < / span > < span class = "nx" > John< / span > < span class = "p" > :< / span > < span class = "nx" > Fight< / span > < span class = "nx" > against< / span > < span class = "nx" > hypochondria< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > end< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Avast< / span > < span class = "nx" > right< / span > < span class = "nx" > o'< / span > < span class = "nx" > John< / span > < span class = "p" > :< / span > < span class = "nx" > Rational< / span > < span class = "nx" > thoughts< / span > < span class = "p" > !< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > John< / span > < span class = "o" > --> > < / span > < span class = "nx" > Alice< / span > < span class = "p" > :< / span > < span class = "nx" > Great< / span > < span class = "p" > !< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > John< / span > < span class = "o" > -> > < / span > < span class = "nx" > Bob< / span > < span class = "p" > :< / span > < span class = "nx" > How< / span > < span class = "nx" > about< / span > < span class = "nx" > ye< / span > < span class = "err" > ?< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Bob< / span > < span class = "o" > --> > < / span > < span class = "nx" > John< / span > < span class = "p" > :< / span > < span class = "nx" > Jolly< / span > < span class = "nx" > bloody< / span > < span class = "p" > !< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
%%{init:{" fontFamily" :" monospace" , " sequence" :{" showSequenceNumbers" :true}}}%%
sequenceDiagram
Alice-> > John: Hello John, how be ye?
loop Healthcheck
John-> > John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John--> > Alice: Great!
John-> > Bob: How about ye?
Bob--> > John: Jolly bloody!
< / div >
2022-11-17 22:36:34 +00:00
< h3 id = "class-diagram-with-codefence-syntax" > Class Diagram wit' Codefence Rules< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "s" > ```mermaid
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > classDiagram
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal < |-- Duck
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal < |-- Fish
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal < |-- Zebra
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal : +int age
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal : +Str'n gender
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal: +isMammal()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal: +mate()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > class Duck{
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +Str'n beakColor
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +swim()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +quack()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > class Fish{
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > -int sizeInFeet
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > -canEat()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > class Zebra{
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +bool is_wild
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +run()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" > classDiagram
2022-11-17 22:36:34 +00:00
Animal < |-- Duck
Animal < |-- Fish
Animal < |-- Zebra
Animal : + int age
Animal : + Str'n gender
Animal: + isMammal()
Animal: + mate()
class Duck{
+ Str'n beakColor
+ swim()
+ quack()
}
class Fish{
-int sizeInFeet
-canEat()
}
class Zebra{
+ bool is_wild
+ run()
}< / div > < h3 id = "state-diagram-aligned-to-the-right" > State Diagram Aligned t' th' Right< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "nx" > align< / span > < span class = "p" > =< / span > < span class = "s" > " right" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > stateDiagram< / span > < span class = "o" > -< / span > < span class = "nx" > v2< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > open< / span > < span class = "p" > :< / span > < span class = "nx" > Open< / span > < span class = "nx" > Door< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > closed< / span > < span class = "p" > :< / span > < span class = "nx" > Closed< / span > < span class = "nx" > Door< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > locked< / span > < span class = "p" > :< / span > < span class = "nx" > Locked< / span > < span class = "nx" > Door< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > open< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > closed< / span > < span class = "p" > :< / span > < span class = "nx" > Close< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > closed< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > locked< / span > < span class = "p" > :< / span > < span class = "nx" > Lock< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > locked< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > closed< / span > < span class = "p" > :< / span > < span class = "nx" > Unlock< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > closed< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > open< / span > < span class = "p" > :< / span > < span class = "nx" > Open< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-right zoom" >
2022-11-17 22:36:34 +00:00
stateDiagram-v2
open: Open Door
closed: Closed Door
locked: Locked Door
open --> closed: Close
closed --> locked: Lock
locked --> closed: Unlock
closed --> open: Open
< / div >
2022-11-18 23:02:20 +00:00
< h3 id = "entity-relationship-model" > Entity Relationship Model< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-11-18 23:02:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > erDiagram< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > CUSTOMER< / span > < span class = "p" > }|..|{< / span > < span class = "nx" > DELIVERY< / span > < span class = "o" > -< / span > < span class = "nx" > ADDRESS< / span > < span class = "p" > :< / span > < span class = "nx" > has< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > CUSTOMER< / span > < span class = "o" > ||--< / span > < span class = "nx" > o< / span > < span class = "p" > {< / span > < span class = "nx" > ORDER< / span > < span class = "p" > :< / span > < span class = "nx" > places< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > CUSTOMER< / span > < span class = "o" > ||--< / span > < span class = "nx" > o< / span > < span class = "p" > {< / span > < span class = "nx" > INVOICE< / span > < span class = "p" > :< / span > < span class = "s" > " li'ble for" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > DELIVERY< / span > < span class = "o" > -< / span > < span class = "nx" > ADDRESS< / span > < span class = "o" > ||--< / span > < span class = "nx" > o< / span > < span class = "p" > {< / span > < span class = "nx" > ORDER< / span > < span class = "p" > :< / span > < span class = "nx" > receives< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > INVOICE< / span > < span class = "o" > ||--< / span > < span class = "p" > |{< / span > < span class = "nx" > ORDER< / span > < span class = "p" > :< / span > < span class = "nx" > covers< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > ORDER< / span > < span class = "o" > ||--< / span > < span class = "p" > |{< / span > < span class = "nx" > ORDER< / span > < span class = "o" > -< / span > < span class = "nx" > ITEM< / span > < span class = "p" > :< / span > < span class = "nx" > includes< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > PRODUCT< / span > < span class = "o" > -< / span > < span class = "nx" > CATEGORY< / span > < span class = "o" > ||--< / span > < span class = "p" > |{< / span > < span class = "nx" > PRODUCT< / span > < span class = "p" > :< / span > < span class = "nx" > contains< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > PRODUCT< / span > < span class = "o" > ||--< / span > < span class = "nx" > o< / span > < span class = "p" > {< / span > < span class = "nx" > ORDER< / span > < span class = "o" > -< / span > < span class = "nx" > ITEM< / span > < span class = "p" > :< / span > < span class = "s" > " ordered in" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
erDiagram
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
CUSTOMER ||--o{ ORDER : places
CUSTOMER ||--o{ INVOICE : " li'ble for"
DELIVERY-ADDRESS ||--o{ ORDER : receives
INVOICE ||--|{ ORDER : covers
ORDER ||--|{ ORDER-ITEM : includes
PRODUCT-CATEGORY ||--|{ PRODUCT : contains
PRODUCT ||--o{ ORDER-ITEM : " ordered in"
< / div >
< h3 id = "user-journey" > User Journey< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > journey< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "nx" > My< / span > < span class = "nx" > work'n< / span > < span class = "nx" > day< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "nx" > Go< / span > < span class = "nx" > t'< / span > < span class = "nx" > work< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Make< / span > < span class = "nx" > tea< / span > < span class = "p" > :< / span > < span class = "mi" > 5< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Go< / span > < span class = "nx" > upstairs< / span > < span class = "p" > :< / span > < span class = "mi" > 3< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Do< / span > < span class = "nx" > work< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span > < span class = "p" > ,< / span > < span class = "nx" > Cat< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "nx" > Go< / span > < span class = "nx" > home< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Go< / span > < span class = "nx" > downstairs< / span > < span class = "p" > :< / span > < span class = "mi" > 5< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Sit< / span > < span class = "nx" > down< / span > < span class = "p" > :< / span > < span class = "mi" > 3< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
journey
title My work'n day
section Go t' work
Make tea: 5: Me
Go upstairs: 3: Me
Do work: 1: Me, Cat
section Go home
Go downstairs: 5: Me
Sit down: 3: Me
2022-04-02 13:30:16 +00:00
< / div >
2022-11-17 22:36:34 +00:00
< h3 id = "gantt-chart" > GANTT Chart< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > gantt< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > dateFormat< / span > < span class = "nx" > YYYY< / span > < span class = "o" > -< / span > < span class = "nx" > MM< / span > < span class = "o" > -< / span > < span class = "nx" > DD< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "nx" > Add'n< / span > < span class = "nx" > GANTT< / span > < span class = "nx" > diagram< / span > < span class = "nx" > functionality< / span > < span class = "nx" > t'< / span > < span class = "nx" > Merrrmaid< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "nx" > A< / span > < span class = "nx" > section< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Completed< / span > < span class = "nx" > task< / span > < span class = "p" > :< / span > < span class = "nx" > done< / span > < span class = "p" > ,< / span > < span class = "nx" > des1< / span > < span class = "p" > ,< / span > < span class = "mi" > 2014< / span > < span class = "o" > -< / span > < span class = "mo" > 01< / span > < span class = "o" > -< / span > < span class = "mo" > 06< / span > < span class = "p" > ,< / span > < span class = "mi" > 2014< / span > < span class = "o" > -< / span > < span class = "mo" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 08< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Active< / span > < span class = "nx" > task< / span > < span class = "p" > :< / span > < span class = "nx" > active< / span > < span class = "p" > ,< / span > < span class = "nx" > des2< / span > < span class = "p" > ,< / span > < span class = "mi" > 2014< / span > < span class = "o" > -< / span > < span class = "mo" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 09< / span > < span class = "p" > ,< / span > < span class = "mi" > 3< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Future< / span > < span class = "nx" > task< / span > < span class = "p" > :< / span > < span class = "nx" > des3< / span > < span class = "p" > ,< / span > < span class = "nx" > aft< / span > < span class = "nx" > des2< / span > < span class = "p" > ,< / span > < span class = "mi" > 5< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Future< / span > < span class = "nx" > task2< / span > < span class = "p" > :< / span > < span class = "nx" > des4< / span > < span class = "p" > ,< / span > < span class = "nx" > aft< / span > < span class = "nx" > des3< / span > < span class = "p" > ,< / span > < span class = "mi" > 5< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "nx" > Critical< / span > < span class = "nx" > tasks< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Completed< / span > < span class = "nx" > task< / span > < span class = "nx" > 'n< / span > < span class = "nx" > th'< / span > < span class = "nx" > critical< / span > < span class = "nx" > line< / span > < span class = "p" > :< / span > < span class = "nx" > crit< / span > < span class = "p" > ,< / span > < span class = "nx" > done< / span > < span class = "p" > ,< / span > < span class = "mi" > 2014< / span > < span class = "o" > -< / span > < span class = "mo" > 01< / span > < span class = "o" > -< / span > < span class = "mo" > 06< / span > < span class = "p" > ,< / span > < span class = "mi" > 24< / span > < span class = "nx" > h< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Implement< / span > < span class = "nx" > parser< / span > < span class = "nx" > an'< / span > < span class = "nx" > jison< / span > < span class = "p" > :< / span > < span class = "nx" > crit< / span > < span class = "p" > ,< / span > < span class = "nx" > done< / span > < span class = "p" > ,< / span > < span class = "nx" > aft< / span > < span class = "nx" > des1< / span > < span class = "p" > ,< / span > < span class = "mi" > 2< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Create< / span > < span class = "nx" > tests< / span > < span class = "k" > fer< / span > < span class = "nx" > parser< / span > < span class = "p" > :< / span > < span class = "nx" > crit< / span > < span class = "p" > ,< / span > < span class = "nx" > active< / span > < span class = "p" > ,< / span > < span class = "mi" > 3< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Future< / span > < span class = "nx" > task< / span > < span class = "nx" > 'n< / span > < span class = "nx" > critical< / span > < span class = "nx" > line< / span > < span class = "p" > :< / span > < span class = "nx" > crit< / span > < span class = "p" > ,< / span > < span class = "mi" > 5< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Create< / span > < span class = "nx" > tests< / span > < span class = "k" > fer< / span > < span class = "nx" > renderer< / span > < span class = "p" > :< / span > < span class = "mi" > 2< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Add< / span > < span class = "nx" > t'< / span > < span class = "nx" > Merrrmaid< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-06-05 17:32:37 +00:00
gantt
dateFormat YYYY-MM-DD
title Add'n GANTT diagram functionality t' Merrrmaid
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, aft des2, 5d
Future task2 : des4, aft des3, 5d
section Critical tasks
Completed task 'n th' critical line :crit, done, 2014-01-06,24h
Implement parser an' jison :crit, done, aft des1, 2d
Create tests fer parser :crit, active, 3d
Future task 'n critical line :crit, 5d
Create tests fer renderer :2d
Add t' Merrrmaid :1d
2022-04-02 13:30:16 +00:00
< / div >
2023-02-05 10:13:50 +00:00
< h3 id = "pie-chart-without-zoom" > Pie Chart without Zoom< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "nx" > zoom< / span > < span class = "p" > =< / span > < span class = "s" > " false" < / span > < span class = "p" > > }}< / span >
2022-11-18 23:02:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pie< / span > < span class = "nx" > title< / span > < span class = "nx" > Pets< / span > < span class = "nx" > adopted< / span > < span class = "nx" > by< / span > < span class = "nx" > volunteers< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Dogs" < / span > < span class = "p" > :< / span > < span class = "mi" > 386< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Cats" < / span > < span class = "p" > :< / span > < span class = "mi" > 85< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Rats" < / span > < span class = "p" > :< / span > < span class = "mi" > 15< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-11-17 22:36:34 +00:00
< div class = "mermaid align-center" >
2022-11-18 23:02:20 +00:00
pie title Pets adopted by volunteers
" Dogs" : 386
" Cats" : 85
" Rats" : 15
2022-04-02 13:30:16 +00:00
< / div >
2022-11-18 23:02:20 +00:00
< h3 id = "requirement-diagram" > Requirement Diagram< / h3 >
2022-11-17 22:36:34 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-11-18 23:02:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > requirementDiagram< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > requirement< / span > < span class = "nx" > test_req< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > id< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > text< / span > < span class = "p" > :< / span > < span class = "nx" > th'< / span > < span class = "nx" > test< / span > < span class = "nx" > text< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > risk< / span > < span class = "p" > :< / span > < span class = "nx" > high< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > verifymethod< / span > < span class = "p" > :< / span > < span class = "nx" > test< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > element< / span > < span class = "nx" > test_entity< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "kd" > type< / span > < span class = "p" > :< / span > < span class = "nx" > simulat'n< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > test_entity< / span > < span class = "o" > -< / span > < span class = "nx" > satisfies< / span > < span class = "o" > -< / span > < span class = "p" > > < / span > < span class = "nx" > test_req< / span >
2022-11-17 22:36:34 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-10-31 14:31:20 +00:00
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
requirementDiagram
requirement test_req {
id: 1
text: th' test text.
risk: high
verifymethod: test
}
element test_entity {
type: simulat'n
}
test_entity - satisfies -> test_req
2022-11-17 22:36:34 +00:00
< / div >
< h3 id = "git-graph" > Git Graph< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > gitGraph< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > branch< / span > < span class = "nx" > develop< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > checkout< / span > < span class = "nx" > develop< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > checkout< / span > < span class = "nx" > main< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > merge< / span > < span class = "nx" > develop< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-17 22:36:34 +00:00
gitGraph
commit
commit
branch develop
checkout develop
commit
commit
checkout main
merge develop
commit
commit
< / div >
2022-11-18 23:02:20 +00:00
< h3 id = "c4-diagrams" > C4 Diagrams< / h3 >
2022-11-17 22:36:34 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-11-18 23:02:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > C4Context< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "nx" > System< / span > < span class = "nx" > Context< / span > < span class = "nx" > diagram< / span > < span class = "k" > fer< / span > < span class = "nx" > Internet< / span > < span class = "nx" > Bank'n< / span > < span class = "nx" > System< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Enterprise_Boundary< / span > < span class = "p" > (< / span > < span class = "nx" > b0< / span > < span class = "p" > ,< / span > < span class = "s" > " BankBoundary0" < / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Person< / span > < span class = "p" > (< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "s" > " Bank'n Customer A" < / span > < span class = "p" > ,< / span > < span class = "s" > " A customer o' th' bank, wit' personal bank accounts." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Person< / span > < span class = "p" > (< / span > < span class = "nx" > customerB< / span > < span class = "p" > ,< / span > < span class = "s" > " Bank'n Customer B" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Person_Ext< / span > < span class = "p" > (< / span > < span class = "nx" > customerC< / span > < span class = "p" > ,< / span > < span class = "s" > " Bank'n Customer C" < / span > < span class = "p" > ,< / span > < span class = "s" > " desc" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Person< / span > < span class = "p" > (< / span > < span class = "nx" > customerD< / span > < span class = "p" > ,< / span > < span class = "s" > " Bank'n Customer D" < / span > < span class = "p" > ,< / span > < span class = "s" > " A customer o' th' bank, < br/> wit' personal bank accounts." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "s" > " Internet Bank'n System" < / span > < span class = "p" > ,< / span > < span class = "s" > " Allows customers t' view informat'n about their bank accounts, an' make payments." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Enterprise_Boundary< / span > < span class = "p" > (< / span > < span class = "nx" > b1< / span > < span class = "p" > ,< / span > < span class = "s" > " BankBoundary" < / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > SystemDb_Ext< / span > < span class = "p" > (< / span > < span class = "nx" > SystemE< / span > < span class = "p" > ,< / span > < span class = "s" > " Mainframe Bank'n System" < / span > < span class = "p" > ,< / span > < span class = "s" > " Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System_Boundary< / span > < span class = "p" > (< / span > < span class = "nx" > b2< / span > < span class = "p" > ,< / span > < span class = "s" > " BankBoundary2" < / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System< / span > < span class = "p" > (< / span > < span class = "nx" > SystemA< / span > < span class = "p" > ,< / span > < span class = "s" > " Bank'n System A" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System< / span > < span class = "p" > (< / span > < span class = "nx" > SystemB< / span > < span class = "p" > ,< / span > < span class = "s" > " Bank'n System B" < / span > < span class = "p" > ,< / span > < span class = "s" > " A system o' th' bank, wit' personal bank accounts. next line." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System_Ext< / span > < span class = "p" > (< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "s" > " E-mail system" < / span > < span class = "p" > ,< / span > < span class = "s" > " The internal Microsoft Exchange e-mail system." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > SystemDb< / span > < span class = "p" > (< / span > < span class = "nx" > SystemD< / span > < span class = "p" > ,< / span > < span class = "s" > " Bank'n System D Database" < / span > < span class = "p" > ,< / span > < span class = "s" > " A system o' th' bank, wit' personal bank accounts." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Boundary< / span > < span class = "p" > (< / span > < span class = "nx" > b3< / span > < span class = "p" > ,< / span > < span class = "s" > " BankBoundary3" < / span > < span class = "p" > ,< / span > < span class = "s" > " boundary" < / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > SystemQueue< / span > < span class = "p" > (< / span > < span class = "nx" > SystemF< / span > < span class = "p" > ,< / span > < span class = "s" > " Bank'n System F Queue" < / span > < span class = "p" > ,< / span > < span class = "s" > " A system o' th' bank." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > SystemQueue_Ext< / span > < span class = "p" > (< / span > < span class = "nx" > SystemG< / span > < span class = "p" > ,< / span > < span class = "s" > " Bank'n System G Queue" < / span > < span class = "p" > ,< / span > < span class = "s" > " A system o' th' bank, wit' personal bank accounts." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > BiRel< / span > < span class = "p" > (< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "s" > " Uses" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > BiRel< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemE< / span > < span class = "p" > ,< / span > < span class = "s" > " Uses" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Rel< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "s" > " Sends e-mails" < / span > < span class = "p" > ,< / span > < span class = "s" > " SMTP" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Rel< / span > < span class = "p" > (< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "s" > " Sends e-mails to" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateElementStyle< / span > < span class = "p" > (< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > fontColor< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > bgColor< / span > < span class = "p" > =< / span > < span class = "s" > " grey" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > borderColor< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateRelStyle< / span > < span class = "p" > (< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > textColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > lineColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetX< / span > < span class = "p" > =< / span > < span class = "s" > " 5" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateRelStyle< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemE< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > textColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > lineColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetY< / span > < span class = "p" > =< / span > < span class = "s" > " -10" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateRelStyle< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > textColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > lineColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetY< / span > < span class = "p" > =< / span > < span class = "s" > " -40" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetX< / span > < span class = "p" > =< / span > < span class = "s" > " -50" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateRelStyle< / span > < span class = "p" > (< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > textColor< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > lineColor< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetX< / span > < span class = "p" > =< / span > < span class = "s" > " -50" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetY< / span > < span class = "p" > =< / span > < span class = "s" > " 20" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateLayoutConfig< / span > < span class = "p" > (< / span > < span class = "err" > $< / span > < span class = "nx" > c4ShapeInRow< / span > < span class = "p" > =< / span > < span class = "s" > " 3" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > c4BoundaryInRow< / span > < span class = "p" > =< / span > < span class = "s" > " 1" < / span > < span class = "p" > )< / span >
2022-11-17 22:36:34 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
C4Context
title System Context diagram fer Internet Bank'n System
Enterprise_Boundary(b0, " BankBoundary0" ) {
Person(customerA, " Bank'n Customer A" , " A customer o' th' bank, wit' personal bank accounts." )
Person(customerB, " Bank'n Customer B" )
Person_Ext(customerC, " Bank'n Customer C" , " desc" )
Person(customerD, " Bank'n Customer D" , " A customer o' th' bank, < br/> wit' personal bank accounts." )
System(SystemAA, " Internet Bank'n System" , " Allows customers t' view informat'n about their bank accounts, an' make payments." )
Enterprise_Boundary(b1, " BankBoundary" ) {
SystemDb_Ext(SystemE, " Mainframe Bank'n System" , " Stores all o' th' core bank'n informat'n about customers, accounts, transact'ns, etc." )
System_Boundary(b2, " BankBoundary2" ) {
System(SystemA, " Bank'n System A" )
System(SystemB, " Bank'n System B" , " A system o' th' bank, wit' personal bank accounts. next line." )
}
System_Ext(SystemC, " E-mail system" , " The internal Microsoft Exchange e-mail system." )
SystemDb(SystemD, " Bank'n System D Database" , " A system o' th' bank, wit' personal bank accounts." )
Boundary(b3, " BankBoundary3" , " boundary" ) {
SystemQueue(SystemF, " Bank'n System F Queue" , " A system o' th' bank." )
SystemQueue_Ext(SystemG, " Bank'n System G Queue" , " A system o' th' bank, wit' personal bank accounts." )
}
}
}
BiRel(customerA, SystemAA, " Uses" )
BiRel(SystemAA, SystemE, " Uses" )
Rel(SystemAA, SystemC, " Sends e-mails" , " SMTP" )
Rel(SystemC, customerA, " Sends e-mails to" )
UpdateElementStyle(customerA, $fontColor=" red" , $bgColor=" grey" , $borderColor=" red" )
UpdateRelStyle(customerA, SystemAA, $textColor=" blue" , $lineColor=" blue" , $offsetX=" 5" )
UpdateRelStyle(SystemAA, SystemE, $textColor=" blue" , $lineColor=" blue" , $offsetY=" -10" )
UpdateRelStyle(SystemAA, SystemC, $textColor=" blue" , $lineColor=" blue" , $offsetY=" -40" , $offsetX=" -50" )
UpdateRelStyle(SystemC, customerA, $textColor=" red" , $lineColor=" red" , $offsetX=" -50" , $offsetY=" 20" )
UpdateLayoutConfig($c4ShapeInRow=" 3" , $c4BoundaryInRow=" 1" )
2022-11-17 22:36:34 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "notice" > Notice< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2023-01-24 22:59:44 +00:00
< p > Th' < code > notice< / code > shortcode shows various types o' disclaimers wit' adjust'ble color, title an' ay'con t' help ye structure yer plank.< / p >
2022-05-23 22:38:50 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle primary" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > There may be pirates< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > It be all about th' boxes.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shortcode from yer own partials.< / p >
2022-05-23 22:38:50 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-05-23 22:38:50 +00:00
< div class = "tab-nav" >
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-05-23 22:38:50 +00:00
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-05-23 22:38:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-05-23 22:38:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " There may be pirates" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " skull-crossbones" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > It< / span > < span class = "nx" > be< / span > < span class = "nx" > all< / span > < span class = "nx" > about< / span > < span class = "nx" > th'< / span > < span class = "nx" > boxes< / span > < span class = "p" > .< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-05-23 22:38:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > primary< / span > < span class = "s" > " There may be pirates" < / span > < span class = "s" > " skull-crossbones" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > It< / span > < span class = "nx" > be< / span > < span class = "nx" > all< / span > < span class = "nx" > about< / span > < span class = "nx" > th'< / span > < span class = "nx" > boxes< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/notice.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " style" < / span > < span class = "s" > " primary" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " title" < / span > < span class = "s" > " There may be pirates" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " skull-crossbones" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " It be all about th' boxes." < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Posit'n< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > style< / strong > < / td >
< td style = "text-align:left" > 1< / td >
< td style = "text-align:left" > < code > default< / code > < / td >
2023-01-23 23:14:54 +00:00
< td style = "text-align:left" > Th' style scheme used fer th' box.< br > < br > - by severity: < code > info< / code > , < code > note< / code > , < code > tip< / code > , < code > warning< / code > < br > - by brand color: < code > primary< / code > , < code > secondary< / code > , < code > accent< / code > < br > - by color: < code > blue< / code > , < code > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > < / td >
2023-01-23 22:49:15 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > color< / strong > < / td >
< td style = "text-align:left" > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > Th' < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > t' be used. If not set, th' chosen color depends on th' < strong > style< / strong > . Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n color fer th' severity< br > - fer all other styles: th' correspond'n color< / td >
2022-05-23 22:38:50 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > title< / strong > < / td >
< td style = "text-align:left" > 2< / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > Arbitrary text fer th' box title. Depend'n on th' < strong > style< / strong > there may be a default title. Any given value will overwrite th' default.< br > < br > - fer severity styles: th' match'n title fer th' severity< br > - fer all other styles: < em > < empty> < / em > < br > < br > If ye want no title fer a severity style, ye have t' set this parameter t' < code > " " < / code > (a non empty str'n filled wit' spaces)< / td >
2022-05-23 22:38:50 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > ay'con< / strong > < / td >
< td style = "text-align:left" > 3< / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > < a href = "../shortcodes/icon/#finding-an-icon" > Font Awesome ay'con name< / a > set t' th' left o' th' title. Depend'n on th' < strong > style< / strong > there may be a default ay'con. Any given value will overwrite th' default.< br > < br > - fer severity styles: a nice match'n ay'con fer th' severity< br > - fer all other styles: < em > < empty> < / em > < br > < br > If ye want no ay'con fer a severity style, ye have t' set this parameter t' < code > " " < / code > (a non empty str'n filled wit' spaces)< / td >
2022-05-23 22:38:50 +00:00
< / tr >
2022-06-22 22:08:50 +00:00
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-10-31 14:06:51 +00:00
< td style = "text-align:left" > Arbitrary text t' be displayed 'n box.< / td >
2022-06-22 22:08:50 +00:00
< / tr >
2022-05-23 22:38:50 +00:00
< / tbody >
< / table >
2022-04-02 13:30:16 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-05-23 22:38:50 +00:00
< h3 id = "by-severity" > By Severity< / h3 >
< h4 id = "info-with-markup" > Ahoi wit' marrrkup< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > An< / span > < span class = "o" > **< / span > < span class = "nx" > informat'n< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-05-23 13:00:05 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Ye< / span > < span class = "nx" > can< / span > < span class = "nx" > add< / span > < span class = "nx" > standard< / span > < span class = "nx" > markdown< / span > < span class = "nx" > rules< / span > < span class = "p" > :< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > multiple< / span > < span class = "nx" > paragraphs< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > bullet< / span > < span class = "nx" > point< / span > < span class = "nx" > lists< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > _emphasized_< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "nx" > bold< / span > < span class = "o" > **< / span > < span class = "nx" > an'< / span > < span class = "nx" > even< / span > < span class = "o" > ***< / span > < span class = "nx" > bold< / span > < span class = "nx" > emphasized< / span > < span class = "o" > ***< / span > < span class = "nx" > text< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "p" > [< / span > < span class = "nx" > links< / span > < span class = "p" > ](< / span > < span class = "nx" > https< / span > < span class = "p" > :< / span > < span class = "c1" > //example.com)
2022-05-23 13:00:05 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c1" > < / span > < span class = "o" > -< / span > < span class = "nx" > etc< / span > < span class = "p" > .< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```plaintext
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ...and even source code
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-10-31 14:06:51 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > > < / span > < span class = "nx" > th'< / span > < span class = "nx" > possibilities< / span > < span class = "nx" > be< / span > < span class = "nf" > endless< / span > < span class = "p" > (< / span > < span class = "nx" > almost< / span > < span class = "o" > -< / span > < span class = "nx" > includ'n< / span > < span class = "nx" > other< / span > < span class = "nx" > shorrrtcodes< / span > < span class = "nx" > may< / span > < span class = "nx" > or< / span > < span class = "nx" > may< / span > < span class = "nx" > not< / span > < span class = "nx" > work< / span > < span class = "p" > )< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle info" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-info-circle" > < / i > Ahoi< / div >
< div class = "box-content" >
2022-06-07 18:30:50 +00:00
< p > An < strong > informat'n< / strong > disclaimer< / p >
< p > Ye can add standard markdown rules:< / p >
< ul >
< li > multiple paragraphs< / li >
< li > bullet point lists< / li >
< li > < em > emphasized< / em > , < strong > bold< / strong > an' even < strong > < em > bold emphasized< / em > < / strong > text< / li >
2022-12-23 11:24:54 +00:00
< li > < a href = "https://example.com" target = "_blank" > links< / a > < / li >
2022-06-07 18:30:50 +00:00
< li > etc.< / li >
< / ul >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ...and even source code
< / span > < / span > < / code > < / pre > < / div > < blockquote >
2022-10-31 14:06:51 +00:00
< p > th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)< / p >
2022-06-07 18:30:50 +00:00
< / blockquote >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "note" > Avast< / h4 >
2022-05-23 22:38:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " note" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > notice< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-06-07 18:30:50 +00:00
< p > A < strong > notice< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< h4 id = "tip" > Smarrrt Arrrse< / h4 >
2022-06-07 18:30:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " tip" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > tip< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle tip" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-lightbulb" > < / i > Smarrrt Arrrse< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > A < strong > tip< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< h4 id = "warning" > Arrr< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > warning< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > Arrr< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > warning< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "warning-with-non-default-title-and-icon" > Arrr wit' Non-Default Title an' Ay'con< / h4 >
2022-05-23 22:38:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Here be dragons" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " dragon" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > warning< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-dragon" > < / i > Here be dragons< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > warning< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "warning-without-a-title-and-icon" > Arrr without a Title an' Ay'con< / h4 >
2022-05-23 22:38:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > warning< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < / div >
< div class = "box-content" >
2022-06-07 18:30:50 +00:00
< p > A < strong > warning< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
< h3 id = "by-brand-colors" > By Brand Colors< / h3 >
2022-06-05 17:32:37 +00:00
< h4 id = "primary-with-title-only" > Primary wit' Title only< / h4 >
2022-06-07 18:30:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Primary" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > primary< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle primary" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > Primary< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > primary< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "secondary-with-icon-only" > Secondary wit' Ay'con only< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " secondary" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " stopwatch" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > secondary< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle secondary" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-stopwatch" > < / i > < / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > secondary< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2023-01-23 23:14:54 +00:00
< h4 id = "accent" > Accent< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " accent" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > An< / span > < span class = "o" > **< / span > < span class = "nx" > accent< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle accent" >
< div class = "box-label" > < / div >
< div class = "box-content" >
< p > An < strong > accent< / strong > disclaimer< / p >
< / div >
< / div >
2022-05-23 22:38:50 +00:00
< h3 id = "by-color" > By Color< / h3 >
2022-06-05 17:32:37 +00:00
< h4 id = "blue-without-a-title-and-icon" > Blue without a Title an' Ay'con< / h4 >
2022-06-07 18:30:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > blue< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle blue" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > blue< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "green-with-title-only" > Green wit' Title only< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " green" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Green" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > green< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle green" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > Green< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > green< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "grey-with-icon-only" > Grey wit' Ay'con only< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " grey" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " bug" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > grey< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle grey" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-bug" > < / i > < / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > grey< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "orange-with-title-and-icon" > Orange wit' Title an' Ay'con< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " orange" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Orange" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " bug" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > orange< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle orange" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-bug" > < / i > Orange< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > orange< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2023-01-14 00:40:32 +00:00
< h4 id = "red-without-a-title-and-icon" > Red without a Title an' Ay'con< / h4 >
2022-06-07 18:30:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > red< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle red" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > red< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
< h3 id = "by-special-color" > By Special Color< / h3 >
2023-01-23 22:49:15 +00:00
< h4 id = "default-with-positional-parameter" > Default wit' Positional Parameter< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "k" > default< / span > < span class = "s" > " Pay Attent'n t' this Avast!" < / span > < span class = "s" > " skull-crossbones" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Some< / span > < span class = "nx" > serious< / span > < span class = "nx" > informat'n< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle default" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Pay Attent'n t' this Avast!< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > Some serious informat'n.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "transparent-with-title-and-icon" > Transparent wit' Title an' Ay'con< / h4 >
2023-01-23 22:49:15 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " transparent" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Pay Attent'n t' this Avast!" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " skull-crossbones" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Some< / span > < span class = "nx" > serious< / span > < span class = "nx" > informat'n< / span > < span class = "p" > .< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle transparent" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Pay Attent'n t' this Avast!< / div >
< div class = "box-content" >
2022-06-07 18:30:50 +00:00
< p > Some serious informat'n.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-01-23 22:49:15 +00:00
< h3 id = "with-user-defined-color-and-font-awesome-brand-icon" > Wit' User-Defined Color an' Font Awesome Brand Ay'con< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Hugo" < / span > < span class = "nx" > ay'con< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Victor< / span > < span class = "err" > ?< / span > < span class = "nx" > Be< / span > < span class = "nx" > it< / span > < span class = "nx" > ye< / span > < span class = "err" > ?< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle default" style = "--VARIABLE-BOX-color: fuchsia;" >
< div class = "box-label" > < i class = "fab fa-hackerrank" > < / i > Cap'n Hugo< / div >
< div class = "box-content" >
< p > Victor? Be it ye?< / p >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "ship-param" > Ship param< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2023-01-24 22:59:44 +00:00
< p > Th' < code > siteparam< / code > shortcode prints values o' ship params.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional aswell or call this shortcode from yer own partials.< / p >
2022-06-05 17:32:37 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
2022-06-22 22:08:50 +00:00
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > siteparam< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " editURL" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > siteparam< / span > < span class = "s" > " editURL" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/siteparam.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " name" < / span > < span class = "s" > " editURL" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Posit'n< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > name< / strong > < / td >
< td style = "text-align:left" > 1< / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > Th' name o' th' ship param t' be displayed.< / td >
< / tr >
< / tbody >
< / table >
2022-04-02 13:30:16 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-06-05 17:32:37 +00:00
< h3 id = "editurl-from-configtoml" > < code > editURL< / code > from < code > config.toml< / code > < / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "s" > `editURL`< / span > < span class = "nx" > value< / span > < span class = "p" > :< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > siteparam< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " editURL" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-23 11:24:54 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < code > editURL< / code > value: < a href = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/" target = "_blank" > https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/< / a > < / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "swaggerrr" > Swaggerrr< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2022-05-29 22:03:12 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Arrr! Pirrrates< / div >
< div class = "box-content" >
2023-02-10 16:31:44 +00:00
< p > Fello' pirrrates, grog made us dizzy! Be awarrre < b > some stuff may not work< / b > in this trrranslat'n. Like see'n < b > Merrrmaids< / b > , do'n < b > math or chemistrrry< / b > , writ'n docs and stuff.< / p >
2022-12-04 10:37:18 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-01-24 22:59:44 +00:00
< p > Th' < code > swagger< / code > shortcode uses th' < a href = "https://mrin9.github.io/RapiDoc" target = "_blank" > RapiDoc< / a > library t' display yer Swagger / OpenAPI Specificat'ns.< / p >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > This only works 'n modern browsers.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.< / p >
2022-06-22 22:08:50 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > swagger< / span > < span class = "nx" > src< / span > < span class = "p" > =< / span > < span class = "s" > " https://petstore3.swagger.io/api/v3/openapi.json" < / span > < span class = "p" > > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/swagger.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " src" < / span > < span class = "s" > " https://petstore3.swagger.io/api/v3/openapi.json" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
2022-06-05 17:32:37 +00:00
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > src< / strong > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > Th' URL t' th' OpenAPI Specificat'n file. This can be relative t' th' URL o' yer plank if it be a leaf or branch bundle.< / td >
< / tr >
< / tbody >
< / table >
2022-10-06 20:51:16 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-10-06 20:51:16 +00:00
< p > If ye want t' print out (or generate a PDF) from yer Swagger documentat'n, don’ t initiate print'n directly from th' plank because th' elements be optimized fer interactive usage 'n a browser.< / p >
2022-12-16 17:42:17 +00:00
< p > Instead, open th' < a href = "../basics/configuration/#activate-print-support" > print preview< / a > 'n yer browser an' initiate print'n from that plank. This plank be optimized fer read'n an' expands most o' th' avail'ble sections.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-10-06 20:51:16 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "configuration" > Configurat'n< / h2 >
< p > Swagger be configured wit' default sett'ns. Ye can cust'mize Swagger’ s default sett'ns fer all o' yer files thru a JSON object 'n yer < code > config.toml< / code > or override these sett'ns per plank thru yer planks frontmatter.< / p >
< p > Th' JSON object o' yer < code > config.toml< / code > / frontmatter be forwarded into Swagger’ s initializat'n. At th' moment, only th' < code > theme< / code > sett'n be supported.< / p >
< p > Th' < code > theme< / code > sett'n can also be set by yer used color variant. This will be th' sitewide default an' can - again - be overridden by yer sett'ns 'n < code > config.toml< / code > or frontmatter.< / p >
2022-06-05 17:32:37 +00:00
< h3 id = "global-configuration-file" > Global Configurat'n File< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > swaggerInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" theme\" : \" dark\" }" < / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div > < h2 id = "example" > Example< / h2 >
< h3 id = "using-local-file" > Us'n Local File< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > swagger< / span > < span class = "nx" > src< / span > < span class = "p" > =< / span > < span class = "s" > " petstore.json" < / span > < span class = "p" > > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-04-02 13:30:16 +00:00
< rapi-doc
allow-spec-file-download="true"
2022-10-06 13:49:10 +00:00
allow-server-selection="true"
allow-try="true"
2022-10-06 20:30:40 +00:00
font-size="largest"
2022-10-06 13:49:10 +00:00
render-style="view"
2022-04-02 13:30:16 +00:00
default-schema-tab="example"
layout="column"
load-fonts="false"
schema-description-expanded="true"
schema-style="table"
show-header="false"
2022-11-05 23:35:48 +00:00
spec-url="../shortcodes/swagger/petstore.json"
2022-04-02 13:30:16 +00:00
sort-tags="true"
>< / rapi-doc >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2023-01-14 00:40:32 +00:00
< h1 id = "tabs" > Tabs< / h1 >
2022-04-02 13:30:16 +00:00
2022-07-05 22:16:52 +00:00
2023-01-24 22:59:44 +00:00
< p > Th' < code > tabs< / code > shortcode displays arbitrary rrrambl'n 'n unlimited number o' tabs.< / p >
2023-01-14 00:40:32 +00:00
< p > This comes 'n handy eg. fer provid'n code snippets fer multiple languages or provid'n configurat'n 'n different formats.< / p >
2022-04-02 13:30:16 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-language" >
2022-04-02 13:30:16 +00:00
< div class = "tab-nav" >
< button
data-tab-item="python"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-05-29 21:35:48 +00:00
onclick="switchTab('tabs-example-language','python')"
2023-01-29 16:05:10 +00:00
>
< span > python< / span > < / button >
2022-04-02 13:30:16 +00:00
< button
2022-06-05 17:32:37 +00:00
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-05 17:32:37 +00:00
onclick="switchTab('tabs-example-language','bash')"
2023-01-29 16:05:10 +00:00
>
< span > bash< / span > < / button >
2022-04-02 13:30:16 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="python"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-python" data-lang = "python" > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " Hello World!" < / span > < span class = "p" > )< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-bash" data-lang = "bash" > < span class = "line" > < span class = "cl" > < span class = "nb" > echo< / span > < span class = "s2" > " Hello World!" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "usage" > Usage< / h2 >
2023-01-24 22:59:44 +00:00
< p > While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' also call this shortcode from yer own partials.< / p >
2022-06-22 22:08:50 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " python" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```python
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > print(" Hello World!" )
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " bash" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```bash
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > echo " Hello World!"
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tabs< / span > < span class = "p" > > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/tabs.html" < / span > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " context" < / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " tabs" < / span > < span class = "p" > (< / span > < span class = "nf" > slice< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " name" < / span > < span class = "s" > " python" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "p" > (< / span > < span class = "s" > " ```python\nprint(\" Hello World!\" )\n```" < / span > < span class = "p" > |< / span > < span class = "nx" > markdownify< / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " name" < / span > < span class = "s" > " bash" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "p" > (< / span > < span class = "s" > " ```bash\necho \" Hello World!\" \n```" < / span > < span class = "p" > |< / span > < span class = "nx" > markdownify< / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
2022-06-05 17:32:37 +00:00
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
2022-06-23 11:25:28 +00:00
< td style = "text-align:left" > < strong > groupid< / strong > < / td >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < code > default< / code > < / td >
2022-10-02 22:25:49 +00:00
< td style = "text-align:left" > Arbitrary name o' th' group th' tab view belongs t'.< br > < br > Tab views wit' th' same < strong > groupid< / strong > sychr'nize their selected tab. This sychronizat'n applies t' th' whole ship!< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > Arbitrary number o' tabs defined wit' th' < code > tab< / code > sub-shortcode.< / td >
< / tr >
< / tbody >
< / table >
2022-04-02 13:30:16 +00:00
2022-06-22 22:08:50 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Avast< / div >
< div class = "box-content" >
2022-06-23 11:25:28 +00:00
< p > When us'n tab views wit' different rrrambl'n sets, make sure t' use a common < code > groupid< / code > fer equal sets o' tabs but distinct < code > groupid< / code > fer different sets.< / p >
< p > Th' tab select'n be restored automatically based on th' < code > groupid< / code > an' if it cannot find a tab item because it came from th' < code > 'default'< / code > group on a different plank then th' first tab be selected instead.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-06-23 11:25:28 +00:00
< h3 id = "distinct-groupid" > Distinct < code > groupid< / code > < / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " config" < / span > < span class = "p" > > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " json" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```json
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > {
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Hello" : " World"
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " XML" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```xml
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > < Hello> World< /Hello>
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " properties" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```properties
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Hello = World
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tabs< / span > < span class = "p" > > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-config" >
2022-04-02 13:30:16 +00:00
< div class = "tab-nav" >
< button
data-tab-item="json"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-05-29 21:35:48 +00:00
onclick="switchTab('tabs-example-config','json')"
2023-01-29 16:05:10 +00:00
>
< span > json< / span > < / button >
2022-04-02 13:30:16 +00:00
< button
data-tab-item="XML"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-05-29 21:35:48 +00:00
onclick="switchTab('tabs-example-config','XML')"
2023-01-29 16:05:10 +00:00
>
< span > XML< / span > < / button >
2022-04-02 13:30:16 +00:00
< button
data-tab-item="properties"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-05-29 21:35:48 +00:00
onclick="switchTab('tabs-example-config','properties')"
2023-01-29 16:05:10 +00:00
>
< span > properties< / span > < / button >
2022-04-02 13:30:16 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="json"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " Hello" < / span > < span class = "p" > :< / span > < span class = "s2" > " World" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="XML"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-xml" data-lang = "xml" > < span class = "line" > < span class = "cl" > < span class = "nt" > < Hello> < / span > World< span class = "nt" > < /Hello> < / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="properties"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-ini" data-lang = "ini" > < span class = "line" > < span class = "cl" > < span class = "na" > Hello< / span > < span class = "o" > =< / span > < span class = "s" > World< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2022-06-23 11:25:28 +00:00
< h3 id = "non-distinct-groupid" > Non-Distinct < code > groupid< / code > < / h3 >
2022-06-05 17:32:37 +00:00
< p > See what happens t' this tab view if ye select < strong > properties< / strong > tab from th' previous example.< / p >
2022-06-23 11:25:28 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " config" < / span > < span class = "p" > > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " json" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```json
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > {
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Hello" : " World"
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " XML" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```xml
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > < Hello> World< /Hello>
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-config" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
data-tab-item="json"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-05 17:32:37 +00:00
onclick="switchTab('tabs-example-config','json')"
2023-01-29 16:05:10 +00:00
>
< span > json< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
data-tab-item="XML"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-05 17:32:37 +00:00
onclick="switchTab('tabs-example-config','XML')"
2023-01-29 16:05:10 +00:00
>
< span > XML< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="json"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " Hello" < / span > < span class = "p" > :< / span > < span class = "s2" > " World" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="XML"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-xml" data-lang = "xml" > < span class = "line" > < span class = "cl" > < span class = "nt" > < Hello> < / span > World< span class = "nt" > < /Hello> < / span >
< / span > < / span > < / code > < / pre > < / div >
2022-11-17 21:58:05 +00:00
< / div >
< / div >
< / div >
< h3 id = "nested-tabs" > Nested Tabs< / h3 >
< p > In case ye want t' nest tabs, th' parent tab that contains th' subtabs needs t' be declared wit' < code > {{< tab > }}< / code > instead o' < code > {{% tab %}}< / code > . Avast, that 'n this case it be not poss'ble t' put markdown 'n th' parent tab.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " main" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " Text" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Simple< / span > < span class = "nx" > text< / span > < span class = "nx" > be< / span > < span class = "nx" > poss'ble< / span > < span class = "nx" > here< / span > < span class = "o" > ...< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " tabs-example-language" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " python" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Python< / span > < span class = "nx" > be< / span > < span class = "o" > **< / span > < span class = "nx" > super< / span > < span class = "o" > **< / span > < span class = "nx" > easy< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > most< / span > < span class = "nx" > o'< / span > < span class = "nx" > th'< / span > < span class = "nx" > time< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "k" > if< / span > < span class = "nx" > ye< / span > < span class = "nx" > don< / span > < span class = "err" > ' < / span > < span class = "nx" > t< / span > < span class = "nx" > want< / span > < span class = "nx" > t'< / span > < span class = "nx" > output< / span > < span class = "nx" > unicode< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " bash" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Bash< / span > < span class = "nx" > be< / span > < span class = "k" > fer< / span > < span class = "o" > **< / span > < span class = "nx" > hackers< / span > < span class = "o" > **< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " Code" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > ...< / span > < span class = "nx" > but< / span > < span class = "nx" > no< / span > < span class = "nx" > markdown< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " tabs-example-language" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " python" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```python
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > print(" Hello World!" )
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " bash" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```bash
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > echo " Hello World!"
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "main" >
2022-11-17 21:58:05 +00:00
< div class = "tab-nav" >
< button
data-tab-item="Text"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-11-17 21:58:05 +00:00
onclick="switchTab('main','Text')"
2023-01-29 16:05:10 +00:00
>
< span > Text< / span > < / button >
2022-11-17 21:58:05 +00:00
< button
data-tab-item="Code"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-11-17 21:58:05 +00:00
onclick="switchTab('main','Code')"
2023-01-29 16:05:10 +00:00
>
< span > Code< / span > < / button >
2022-11-17 21:58:05 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="Text"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
Simple text be poss'ble here...
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-language" >
2022-11-17 21:58:05 +00:00
< div class = "tab-nav" >
< button
data-tab-item="python"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-11-17 21:58:05 +00:00
onclick="switchTab('tabs-example-language','python')"
2023-01-29 16:05:10 +00:00
>
< span > python< / span > < / button >
2022-11-17 21:58:05 +00:00
< button
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-11-17 21:58:05 +00:00
onclick="switchTab('tabs-example-language','bash')"
2023-01-29 16:05:10 +00:00
>
< span > bash< / span > < / button >
2022-11-17 21:58:05 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="python"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
< p > Python be < strong > super< / strong > easy.< / p >
< ul >
< li > most o' th' time.< / li >
< li > if ye don’ t want t' output unicode< / li >
< / ul >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
< p > Bash be fer < strong > hackers< / strong > .< / p >
< / div >
< / div >
< / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="Code"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
...but no markdown
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-language" >
2022-11-17 21:58:05 +00:00
< div class = "tab-nav" >
< button
data-tab-item="python"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-11-17 21:58:05 +00:00
onclick="switchTab('tabs-example-language','python')"
2023-01-29 16:05:10 +00:00
>
< span > python< / span > < / button >
2022-11-17 21:58:05 +00:00
< button
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-11-17 21:58:05 +00:00
onclick="switchTab('tabs-example-language','bash')"
2023-01-29 16:05:10 +00:00
>
< span > bash< / span > < / button >
2022-11-17 21:58:05 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="python"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-python" data-lang = "python" > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " Hello World!" < / span > < span class = "p" > )< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-bash" data-lang = "bash" > < span class = "line" > < span class = "cl" > < span class = "nb" > echo< / span > < span class = "s2" > " Hello World!" < / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2022-06-05 17:32:37 +00:00
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< / section >
2022-07-17 23:32:02 +00:00
< / section > < / div >
2022-04-02 13:30:16 +00:00
< / main >
< / div >
2023-02-10 23:05:55 +00:00
< script src = "../js/clipboard.min.js?1676070350" defer > < / script >
< script src = "../js/perfect-scrollbar.min.js?1676070350" defer > < / script >
< script src = "../js/theme.js?1676070350" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
