mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-12-03 12:43:05 +00:00
6714 lines
546 KiB
HTML
6714 lines
546 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
||
<meta name="generator" content="Hugo 0.111.3">
|
||
<meta name="generator" content="Relearn 5.13.1+tip">
|
||
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
||
<meta name="author" content="Sören Weber">
|
||
<title>Hugo Relearn Theme</title>
|
||
<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">
|
||
<link href="https://McShelby.github.io/hugo-theme-relearn/index.html" rel="canonical" type="text/html" title="Hugo Relearn Theme">
|
||
<link href="./index.xml" rel="alternate" type="application/rss+xml" title="Hugo Relearn Theme">
|
||
<link href="./images/logo.svg?1684361613" rel="icon" type="image/svg+xml">
|
||
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use -->
|
||
<link href="./css/fontawesome-all.min.css?1684361615" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="./css/fontawesome-all.min.css?1684361615" rel="stylesheet"></noscript>
|
||
<link href="./css/nucleus.css?1684361615" rel="stylesheet">
|
||
<link href="./css/auto-complete.css?1684361615" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="./css/auto-complete.css?1684361615" rel="stylesheet"></noscript>
|
||
<link href="./css/perfect-scrollbar.min.css?1684361615" rel="stylesheet">
|
||
<link href="./css/fonts.css?1684361615" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="./css/fonts.css?1684361615" rel="stylesheet"></noscript>
|
||
<link href="./css/theme.css?1684361615" rel="stylesheet">
|
||
<link href="./css/theme-auto.css?1684361615" rel="stylesheet" id="variant-style">
|
||
<link href="./css/variant.css?1684361615" rel="stylesheet">
|
||
<link href="./css/print.css?1684361615" rel="stylesheet" media="print">
|
||
<link href="./css/format-print.css?1684361615" rel="stylesheet">
|
||
<link href="./css/ie.css?1684361615" rel="stylesheet">
|
||
<script src="./js/url.js?1684361615"></script>
|
||
<script src="./js/variant.js?1684361615"></script>
|
||
<script>
|
||
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
|
||
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
|
||
window.index_js_url="./index.search.js";
|
||
var root_url="./";
|
||
var baseUri=root_url.replace(/\/$/, '');
|
||
// translations
|
||
window.T_Copy_to_clipboard = 'Copy to clipboard';
|
||
window.T_Copied_to_clipboard = 'Copied to clipboard!';
|
||
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
|
||
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
|
||
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
|
||
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
|
||
// some further base stuff
|
||
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
||
window.variants && variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
||
</script>
|
||
<style>
|
||
#body img.bg-white {
|
||
background-color: white;
|
||
}
|
||
</style>
|
||
</head>
|
||
<body class="mobile-support print disableInlineCopyToClipboard" data-url="./index.html">
|
||
<div id="body" class="default-animation">
|
||
<div id="sidebar-overlay"></div>
|
||
<div id="toc-overlay"></div>
|
||
<nav id="topbar" class="highlightable">
|
||
<div>
|
||
<div id="breadcrumbs">
|
||
<span id="sidebar-toggle-span">
|
||
<a href="#" id="sidebar-toggle" class="topbar-link" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
||
</span>
|
||
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
||
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Hugo Relearn Theme</span><meta itemprop="position" content="1"></li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
<main id="body-inner" class="highlightable home" tabindex="-1">
|
||
<div class="flex-block-wrapper">
|
||
<div id="head-tags">
|
||
</div>
|
||
<article class="home">
|
||
<h1 id="hugo-relearn-theme">Hugo Relearn Theme</h1>
|
||
|
||
<p>A theme for <a href="https://gohugo.io/" target="_blank">Hugo</a> designed for documentation.</p>
|
||
<p><a href="./basics/migration/">★ What’s new in the latest release ★</a></p>
|
||
<p>
|
||
<a href="#image-1e851d07746ca385d3145e3c8afde028" class="lightbox-link">
|
||
<img src="./images/hero.png?classes=shadow&width=100%25&height=100%25" alt="Image of the Relearn theme in light and dark mode on phone, tablet and desktop" class="shadow" style="height: auto; width: auto;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-1e851d07746ca385d3145e3c8afde028">
|
||
<img src="./images/hero.png?classes=shadow&width=100%25&height=100%25" alt="Image of the Relearn theme in light and dark mode on phone, tablet and desktop" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
<h2 id="motivation">Motivation</h2>
|
||
<p>The theme is a fork of the great <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn theme</a> with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.</p>
|
||
<h2 id="features">Features</h2>
|
||
<ul>
|
||
<li><strong>Wide set of usage scenarios</strong>
|
||
<ul>
|
||
<li>Responsive design for mobile usage</li>
|
||
<li>Looks nice on paper (if you have to)</li>
|
||
<li>Usable offline, no external dependencies</li>
|
||
<li><a href="./basics/configuration/#serving-your-page-from-the-filesystem">Usable from your local file system via <code>file://</code> protocol</a></li>
|
||
<li>Support for the <a href="https://github.com/estruyf/vscode-front-matter" target="_blank">VSCode Front Matter extension</a> for on-premise CMS capabilities</li>
|
||
<li>Support for Internet Explorer 11</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Configurable theming and visuals</strong>
|
||
<ul>
|
||
<li><a href="./basics/customization/#change-the-logo">Configurable brand images</a></li>
|
||
<li><a href="./basics/customization/#adjusting-to-os-settings">Automatic switch for light/dark variant dependend on your OS settings</a></li>
|
||
<li>Predefined light, dark and color variants</li>
|
||
<li><a href="./basics/customization/#multiple-variants">User selectable variants</a></li>
|
||
<li><a href="./basics/generator/">Stylesheet generator</a></li>
|
||
<li><a href="./cont/syntaxhighlight/">Configurable syntax highlighting</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Unique theme features</strong>
|
||
<ul>
|
||
<li><a href="./basics/configuration/#activate-print-support">Print whole chapters or even the complete site</a></li>
|
||
<li>In page search</li>
|
||
<li><a href="./basics/configuration/#activate-search">Site search</a></li>
|
||
<li><a href="./basics/configuration/#activate-dedicated-search-page">Dedicated search page</a></li>
|
||
<li><a href="./cont/tags/">Tagging support</a></li>
|
||
<li>Hidden pages</li>
|
||
<li>Unlimited nested menu dependend on your site structure</li>
|
||
<li>Navigation buttons dependend on your site structure</li>
|
||
<li><a href="./cont/menushortcuts/">Configurable shortcut links</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Multi language support</strong>
|
||
<ul>
|
||
<li><a href="./cont/i18n/">Full support for languages written right to left</a></li>
|
||
<li><a href="./cont/i18n/#basic-configuration">Available 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>
|
||
<li><a href="./cont/i18n/#search">Search support for mixed language content</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Additional Markdown features</strong>
|
||
<ul>
|
||
<li><a href="./cont/markdown/">Support for GFM (GitHub Flavored Markdown</a></li>
|
||
<li><a href="./cont/markdown/#further-image-formatting">Image styling like sizing, shadow, border and alignment</a></li>
|
||
<li><a href="./cont/markdown/#further-image-formatting#lightbox">Image lightbox</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>Shortcodes galore</strong>
|
||
<ul>
|
||
<li><a href="./shortcodes/attachments/">Display files attached to page bundles</a></li>
|
||
<li><a href="./shortcodes/badge/">Marker badges</a></li>
|
||
<li><a href="./shortcodes/button/">Configurable buttons</a></li>
|
||
<li><a href="./shortcodes/children/">List child pages</a></li>
|
||
<li><a href="./shortcodes/expand/">Expand areas to reveal content</a></li>
|
||
<li><a href="./shortcodes/icon/">Font Awesome icons</a></li>
|
||
<li><a href="./shortcodes/include/">Inclusion of other files</a></li>
|
||
<li><a href="./shortcodes/math/">Math and chemical formulae using MathJax</a></li>
|
||
<li><a href="./shortcodes/mermaid/">Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.</a></li>
|
||
<li><a href="./shortcodes/notice/">Colorful boxes</a></li>
|
||
<li><a href="./shortcodes/siteparam/">Reveal you site’s configuration parameter</a></li>
|
||
<li><a href="./shortcodes/openapi/">Swagger UI for your OpenAPI specifications</a></li>
|
||
<li><a href="./shortcodes/tabs/">Tabbed panels</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id="support">Support</h2>
|
||
<p>To get support, feel free to 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> in the official repository on GitHub.</p>
|
||
<h2 id="contributions">Contributions</h2>
|
||
<p>Feel free to contribute to this documentation by just clicking the
|
||
<span class="btn cstyle transparent">
|
||
<button type="button">
|
||
<i class="fa-fw fas fa-pen"></i>
|
||
|
||
</button>
|
||
</span> button displayed on top right of each page.</p>
|
||
<p>You are most welcome to contribute bugfixes or new features by making pull requests to the <a href="https://github.com/McShelby/hugo-theme-relearn" target="_blank">official repository</a>. Check the <a href="./dev/contributing/">contribution guidelines</a> first before starting.</p>
|
||
<h2 id="license">License</h2>
|
||
<p>The Relearn theme is licensed under the <a href="https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE" target="_blank">MIT License</a>.</p>
|
||
<h2 id="credits">Credits</h2>
|
||
<p>This theme would not be possible without the work of <a href="./more/credits/">many others</a>.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Hugo Relearn Theme</h1>
|
||
<article class="chapter">
|
||
<div class="article-subheading">Chapter 1</div>
|
||
<h1 id="basics">Basics</h1>
|
||
|
||
<p>Discover what this Hugo theme is all about and the core-concepts behind it.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Basics</h1>
|
||
<article class="default">
|
||
<h1 id="whats-new">What's New</h1>
|
||
|
||
<p>This document shows you what’s new in the latest release. For a detailed list of changes, see the <a href="./basics/history/">history page</a>.</p>
|
||
<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> The minimum required Hugo version.</p>
|
||
<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">Breaking</span></span> A change that requires action by you after upgrading to assure the site is still functional.</p>
|
||
<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 in default behavior that may requires action by you if you want to revert it.</p>
|
||
<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 you might find interesting or comes configurable.</p>
|
||
<!--GH-ACTION-RELEASE-MILESTONE-->
|
||
<hr>
|
||
<h2 id="5130-2023-05-16">5.13.0 (2023-05-16)</h2>
|
||
<ul>
|
||
<li>
|
||
<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> The <code>swagger</code> shortcode was deprecated in favor for the <a href="./shortcodes/openapi/"><code>openapi</code> shortcode</a>. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the <code>swagger</code> shortcode in the next major release.</p>
|
||
<p>Additionally, the implemantion of this shortcode was switched from RapiDoc to <a href="https://github.com/swagger-api/swagger-ui" target="_blank">SwaggerUI</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5120-2023-05-04">5.12.0 (2023-05-04)</h2>
|
||
<ul>
|
||
<li>
|
||
<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 the effort to comply with WCAG standards, the implementation of the collapsible menu was changed (again). While Internet Explorer 11 has issues in displaying it, the functionality still works.</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> Support for the great <a href="https://github.com/estruyf/vscode-front-matter" target="_blank">VSCode Front Matter extension</a> which provides on-premise CMS capabilties to Hugo.</p>
|
||
<p>The theme provides Front Matter snippets for its shortcodes. Currently only English and German is supported. Put a reference into your <code>frontmatter.json</code> like this</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="err">...</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"frontMatter.extends"</span><span class="p">:</span> <span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s2">"./vscode-frontmatter/snippets.en.json"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="err">...</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">}</span>
|
||
</span></span></code></pre></div></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> Support for languages that are written right to left (like Arabic) is now complete and extended to the menu, the top navigation bar and print. You can experience this in the <a href="./pir/basics/migration/">pirate translation</a>. This feature is not available in 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> The scrollbars are now colored according to their variant color scheme to better fit into the visuals.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5110-2023-02-07">5.11.0 (2023-02-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<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> The theme removed the popular <a href="https://jquery.com" target="_blank">jQuery</a> library from its distribution.</p>
|
||
<p>In case you made changes to the theme that are dependend on this library you can place a copy of jQuery into your <code>static/js</code> directory and load it from your 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">defer</span><span class="p">></</span><span class="nt">script</span><span class="p">></span>
|
||
</span></span></code></pre></div></li>
|
||
<li>
|
||
<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">Mermaid</a> diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.</p>
|
||
<p>The default setting of <code>on</code>, in effect since 1.1.0, changed back to <code>off</code> as there was interference with scrolling on mobile and big pages.</p>
|
||
</li>
|
||
<li>
|
||
<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> The theme is now capable to visually <a href="./basics/customization/#adjust-to-os-settings">adapt to your OS’s light/dark mode setting</a>.</p>
|
||
<p>This is also the new default setting if you haven’t configured <code>themeVariant</code> in your <code>config.toml</code>.</p>
|
||
<p>Additionally you can configure the variants to be taken for light/dark mode with the new <code>themeVariantAuto</code> parameter.</p>
|
||
<p>This is not supported for Internet Explorer 11, which still displays in the <code>relearn-light</code> variant.</p>
|
||
</li>
|
||
<li>
|
||
<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> The JavaScript code for handling image lightboxes (provided by <a href="https://noelboss.github.io/featherlight" target="_blank">Featherlight</a>) was replaced by a CSS-only solution.</p>
|
||
<p>This also changed the <a href="./cont/markdown/#lightbox">lightbox effects</a> parameter from <code>featherlight=false</code> to <code>lightbox=false</code>. Nevertheless you don’t need to change anything as the old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<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 the effort to comply with WCAG standards, the implementation of the <a href="./shortcodes/expand/"><code>expand</code> shortcode</a> was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works.</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> Translation for Czech. This language is not supported for search.</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="https://github.com/McShelby/hugo-theme-relearn/tags" target="_blank">GitHub releases</a> are also now tagged for the main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) and the latest (just <code>x</code>) release making it easier for you to pin the theme to a certain version.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5100-2023-01-25">5.10.0 (2023-01-25)</h2>
|
||
<ul>
|
||
<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> The <a href="./shortcodes/attachments/"><code>attachments</code></a>, <a href="./shortcodes/badge/"><code>badge</code></a>, <a href="./shortcodes/button/"><code>button</code></a> and <a href="./shortcodes/notice/"><code>notice</code></a> shortcodes have a new parameter <code>color</code> to set arbitrary CSS color values.</p>
|
||
<p>Additionally the <code>--ACCENT-color</code> brand color introduced in version 5.8.0 is now supported with these shortcodes.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="590-2022-12-23">5.9.0 (2022-12-23)</h2>
|
||
<ul>
|
||
<li>
|
||
<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> The required folder name for the <a href="./shortcodes/attachments/"><code>attachments</code> shortcode</a> was changed for leaf bundles.</p>
|
||
<p>Previously, the attachments for leaf bundles in non-multilang setups were required to be in a <code>files</code> subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a <code>_index.<LANGCODE>.files</code> or <code>index.<LANGCODE>.files</code> subdirectory accordingly.</p>
|
||
<p>This added unnessessary complexity. So attachments for leaf bundles in non-multilang setups can now also reside in a <code>index.files</code> directory. Although the old <code>files</code> directory is now deprecated, if both directories are present, only the old <code>files</code> directory will be used for compatiblity.</p>
|
||
</li>
|
||
<li>
|
||
<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 with <code>http://</code> or <code>https://</code> are now opened in a separate browser tab.</p>
|
||
<p>You can revert back to the old behavior by defining <code>externalLinkTarget="_self"</code> in the <code>params</code> section of your <code>config.toml</code>.</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> The theme now supports <a href="https://gohugo.io/hugo-modules/" target="_blank">Hugo’s module system</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="580-2022-12-08">5.8.0 (2022-12-08)</h2>
|
||
<ul>
|
||
<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> The new <a href="./shortcodes/badge/"><code>badge</code> shortcode</a> is now available to add highly configurable markers to your content as you can see it on this page.</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> The new <a href="./shortcodes/icon/"><code>icon</code> shortcode</a> simplyfies the usage of icons. This can even be combined with also new <code>badge</code> shortcode.</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> The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely <a href="./cont/markdown/#tasks">task lists</a>, <a href="./cont/markdown/#defintions">defintion lists</a> and <a href="./cont/markdown/#footnotes">footnotes</a>.</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 new color <code>--ACCENT-color</code> was introduced which is used for highlightning search results on the page. In case you simply don’t care, you don’t need to change anything in your variant stylesheet as the old <code>yellow</code> color is still used as default.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="570-2022-11-29">5.7.0 (2022-11-29)</h2>
|
||
<ul>
|
||
<li>
|
||
<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> The Korean language translation for this theme is now available with the language code <code>ko</code>. Formerly the country code <code>kr</code> was used instead.</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> The <a href="./shortcodes/button/"><code>button</code> shortcode</a> can now also be used as a real button inside of HTML forms - although this is a pretty rare use case. The documentation was updated accordingly.</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> The search now supports the Korean language.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="560-2022-11-18">5.6.0 (2022-11-18)</h2>
|
||
<ul>
|
||
<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> This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning thru large number of results.</p>
|
||
<p>To activate this feature, you need to <a href="./basics/configuration/#activate-dedicated-search-page">configure it</a> in your <code>config.toml</code> as a new outputformat <code>SEARCHPAGE</code> for the home page. If you don’t configure it, no dedicated search page will be accessible and the theme works as before.</p>
|
||
<p>You can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.</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> Keyboard handling for the TOC and search was improved.</p>
|
||
<p>Pressing <code>CTRL+ALT+t</code> now will not only toggle the TOC overlay but also places the focus to the first heading on opening. Subsequently this makes it possible to easily select headings by using the <code>TAB</code> key.</p>
|
||
<p>The search received its own brand new keyboard shortcut <code>CTRL+ALT+f</code>. This will focus the cursor inside of the the search box so you can immediately start your search by typing.</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> You are now able to turn off the generation of generator meta tags in your HTML head to hide the used versions of Hugo and this theme.</p>
|
||
<p>To <a href="./basics/configuration/#global-site-parameters">configure this</a> in your <code>config.toml</code> make sure to set Hugo’s <code>disableHugoGeneratorInject=true</code> <strong>and</strong> also <code>[params] disableGeneratorVersion=true</code>, otherwise Hugo will generate a meta tag into your home page automagically.</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> Creation of your project gets a little bit faster with this release.</p>
|
||
<p>This addresses increased build time with the 5.x releases. The theme now heavily caches partial results leading to improved performance. To further increase performance, unnecessary parts of the page are now skipped for creation of the print output (eg. menus, navigation bar, etc.).</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="550-2022-11-06">5.5.0 (2022-11-06)</h2>
|
||
<ul>
|
||
<li>
|
||
<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> The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview.</p>
|
||
<p>For that the JavaScript code to handle the <a href="./cont/markdown/#further-image-formatting">lightbox and image effects</a> on the client side was removed in favour for static generation of those effects on the server.</p>
|
||
<p>If you have used HTML directly in your Markdown files, this now has the downside that it doesn’t respect the effect query parameter anymore. In this case you have to migrate all your HTML <code>img</code> URLs manually to the 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>
|
||
<h2 id="540-2022-11-01">5.4.0 (2022-11-01)</h2>
|
||
<ul>
|
||
<li>
|
||
<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">With the proper settings</a> in your <code>config.toml</code> your page is now servable from the local file system using <code>file://</code> URLs.</p>
|
||
<p>Please note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your <code>config.toml</code> from <code>JSON</code> to <code>SEARCH</code>. The now deprecated <code>JSON</code> outputformat still works as before, so there is no need to reconfigure your installation if it is only served from <code>http://</code> or <code>https://</code>.</p>
|
||
</li>
|
||
<li>
|
||
<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> The <a href="./shortcodes/button/"><code>button</code> shortcode</a> has a new parameter <code>target</code> to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in a new window/tab.</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> The <a href="./shortcodes/math/"><code>math</code> shortcode</a> and <a href="./shortcodes/mermaid/"><code>mermaid</code> shortcode</a> now also support the <code>align</code> parameter if codefence syntax is used.</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> Support for languages that are written right to left (like Arabic). This is only implemented for the content area but not the navigation sidebar. This feature is not available in 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> Translation for Finnish (Suomi).</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="530-2022-10-07">5.3.0 (2022-10-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<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 the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. The functionality of the new implementation does not work with old browsers (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> <a href="./cont/markdown/#add-css-classes">Image formatting</a> has two new classes to align images to the <code>left</code> or <code>right</code>. Additionally, the already existing <code>inline</code> option is now documented.</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> Printing for the <a href="./shortcodes/openapi/"><code>swagger</code> shortcode</a> was optimized to expand sections that are usually closed in interactive mode. This requires <a href="./basics/configuration/#activate-print-support">print support</a> to be configured.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="520-2022-08-03">5.2.0 (2022-08-03)</h2>
|
||
<ul>
|
||
<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> in your <code>config.toml</code>, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="510-2022-07-15">5.1.0 (2022-07-15)</h2>
|
||
<ul>
|
||
<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.95.0</span></span> This release requires a newer Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<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 the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a <code>index.print.html</code> to the default URL.</p>
|
||
<p>You can revert this behavior by overwriting the PRINT output format setting in your <code>config.toml</code>to:</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">permalinkable</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span></code></pre></div></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="500-2022-07-05">5.0.0 (2022-07-05)</h2>
|
||
<ul>
|
||
<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">Breaking</span></span> The theme changed how JavaScript and CSS dependencies are loaded to provide a better performance. In case you’ve added own JavaScript code that depends on the themes jQuery implementation, you have to put it into a separate <code>*.js</code> file (if not already) and add the <code>defer</code> keyword to the <code>script</code> element. Eg.</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">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>
|
||
<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> The way <a href="./cont/archetypes/">archetypes</a> are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones.</p>
|
||
<p>Your existing markdown files will still work like before and therefore you don’t need to change anything after the upgrade. Nevertheless, it is recommended to adapt your existing markdown files to the new way as follows:</p>
|
||
<ul>
|
||
<li>
|
||
<p>for your home page, add the frontmatter parameter <code>archetype = "home"</code> and remove the leading heading</p>
|
||
</li>
|
||
<li>
|
||
<p>for all files containing the deprecated frontmatter parameter <code>chapter = true</code>, replace it with <code>archetype = "chapter"</code> and remove the leading headings</p>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<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> The frontmatter options <code>pre</code> / <code>post</code> were renamed to <code>menuPre</code> / <code>menuPost</code>. The old options will still be used if the new options aren’t set. Therefore you don’t need to change anything after the upgrade.</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> Adding new partials <code>heading-pre.html</code> / <code>heading-post.html</code> and according frontmatter options <code>headingPre</code> / <code>headingPost</code> to modify the way your page`s main heading gets styled.</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> The new shortcode <code>math</code> is available to add beautiful math and chemical formulae. See the <a href="./shortcodes/math/">documentation</a> for available features. This feature will not work with Internet Explorer 11.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="420-2022-06-23">4.2.0 (2022-06-23)</h2>
|
||
<ul>
|
||
<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">Breaking</span></span> The second parameter for the <a href="./shortcodes/include/"><code>include</code> shortcode</a> was switched in meaning and was renamed from <code>showfirstheading</code> to <code>hidefirstheading</code>. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.</p>
|
||
<p>If you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.</p>
|
||
</li>
|
||
<li>
|
||
<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 the <a href="./shortcodes/tabs/"><code>tabs</code> shortcode</a> could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.</p>
|
||
</li>
|
||
<li>
|
||
<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> The <code>landingPageURL</code> was removed from <code>config.toml</code>. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically.</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> All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="410-2022-06-12">4.1.0 (2022-06-12)</h2>
|
||
<ul>
|
||
<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 fixing issues with the search functionality for non Latin languages, you can now <a href="./cont/i18n/#search-with-mixed-language-support">configure to have multiple languages on a single page</a>.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="400-2022-06-05">4.0.0 (2022-06-05)</h2>
|
||
<ul>
|
||
<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">Breaking</span></span> The <code>custom_css</code> config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the <code>custom-header.html</code> template in a much more generic manner.</p>
|
||
</li>
|
||
<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">Breaking</span></span> Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove <code>--MAIN-ANCHOR-color</code> instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from <code>--MAIN-LINK-color</code> and <code>--MAIN-ANCHOR-HOVER-color</code> respectively.</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> All shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don’t need to change anything in your installation.</p>
|
||
<p>This applies to <a href="./shortcodes/expand/"><code>expand</code></a>, <a href="./shortcodes/include/"><code>include</code></a>, <a href="./shortcodes/notice/"><code>notice</code></a> and <a href="./shortcodes/siteparam/"><code>siteparam</code></a>.</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> The <a href="./shortcodes/button/"><code>button</code></a> shortcode received some love and now has a parameter for the color style similar to other shortcodes.</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> New colors <code>--PRIMARY-color</code> and <code>--SECONDARY-color</code> were added to provide easier modification of your custom style. Shortcodes with a color style can now have <code>primary</code> or <code>secondary</code> as additional values.</p>
|
||
<p>These two colors are the default for other, more specific color variables. You don’t need to change anything in your existing custom color stylesheets as those variables get reasonable default values.</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> Translation for Polish. This language is not supported for search.</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> The documentation for all shortcodes were revised.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="340-2022-04-03">3.4.0 (2022-04-03)</h2>
|
||
<ul>
|
||
<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">Breaking</span></span> If you had previously overwritten the <code>custom-footer.html</code> partial to add visual elements below the content of your page, you have to move this content to the new partial <code>content-footer.html</code>. <code>custom-footer.html</code> was never meant to contain HTML other than additional styles and JavaScript.</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> If you prefer expandable/collapsible menu items, you can now set <code>collapsibleMenu=true</code> in your <code>config.toml</code>. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.</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> You can activate <a href="./basics/configuration/#activate-print-support">print support</a> in your <code>config.toml</code> to add the capability to print whole chapters or even the complete site.</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> Translation for Traditional Chinese.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="330-2022-03-28">3.3.0 (2022-03-28)</h2>
|
||
<ul>
|
||
<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> Introduction of new CSS variables to set the font. The theme distinguishes between <code>--MAIN-font</code> for all content text and <code>--CODE-font</code> for inline or block code. There are additional overrides for all headings. See the <a href="./basics/generator/">theme variant generator</a> of the exampleSite for all available variables.</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> The new shortcode <code>swagger</code> is available to include a UI for REST OpenAPI specifications. See the <a href="./shortcodes/openapi/">documentation</a> for available features. This feature will not work with Internet Explorer 11.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="320-2022-03-19">3.2.0 (2022-03-19)</h2>
|
||
<ul>
|
||
<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.93.0</span></span> This release requires a newer Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<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 the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Mermaid codefences. This changes the behavior of <code>disableMermaid</code> config option as follows: If a Mermaid shortcode or codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.</p>
|
||
<p>The option is still useful in case you are using scripting to set up your graph. In this case no shortcode or codefence is involved and the library is not loaded by default. In this case you can set <code>disableMermaid=false</code> in your frontmatter to force the library to be loaded. See the <a href="./basics/generator/">theme variant generator</a> of the exampleSite for an example.</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> Additional color variant variable <code>--MERMAID-theme</code> to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="310-2022-03-15">3.1.0 (2022-03-15)</h2>
|
||
<ul>
|
||
<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> and <a href="./shortcodes/notice/"><code>notice</code></a> shortcodes have a new parameter to override the default icon. Allowed values are all <a href="https://fontawesome.com/v5/search?m=free" target="_blank">Font Awesome 5 Free</a> icons.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="300-2022-02-22">3.0.0 (2022-02-22)</h2>
|
||
<ul>
|
||
<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">Breaking</span></span> We made changes to the menu footer. If you have your <code>menu-footer.html</code> <a href="./basics/customization/">partial overridden</a>, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the <code>menu-footer.html</code> partial that is coming with the exampleSite.</p>
|
||
<p>This change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and <em>Clear history</em> functionality).</p>
|
||
</li>
|
||
<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">Breaking</span></span> We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.</p>
|
||
<p>This change will only affect your installation if you’ve not set the <code>themeVariant</code> parameter in your <code>config.toml</code>. <a href="./basics/customization/#theme-variant">If you still want to use the Learn color variant</a>, you have to explicitly set <code>themeVariant="learn"</code> in your <code>config.toml</code>.</p>
|
||
<p>Note, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.</p>
|
||
</li>
|
||
<li>
|
||
<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 to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove <code>--MENU-SEARCH-BOX-ICONS-color</code> and introduced <code>--MENU-SEARCH-color</code> instead. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<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> to <code>--MENU-SEARCH-BORDER-color</code>. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</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> With this release you are now capable to define your own <em>dark mode</em> variants.</p>
|
||
<p>To make this possible, we have introduced a lot more color variables you can use in <a href="./basics/customization/#theme-variant">your color variants</a>. Your old variants will still work and don’t need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.</p>
|
||
<p>To see what’s now possible, see the new variants <code>relearn-dark</code> and <code>neon</code> that are coming with this release.</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> To make the creation of new variants easier for you, we’ve added a new interactive <a href="./basics/generator/">theme variant generator</a>. This feature will not work with 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> You can now configure multiple color variants in your <code>config.toml</code>. In this case, the first variant is the default chosen on first view and a variant switch will be shown in the menu footer. See the <a href="./basics/customization/#multiple-variants">documentation</a> for configuration.</p>
|
||
<p>Note, that the new variant switch will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant switcher will not be displayed with Internet Explorer 11.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="290-2021-11-19">2.9.0 (2021-11-19)</h2>
|
||
<ul>
|
||
<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">Breaking</span></span> This release removes the themes implementation of <code>ref</code>/<code>relref</code> in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.</p>
|
||
<p>In a standard compliant form you must not link to the <code>*.md</code> file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:</p>
|
||
<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/configuration</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Leaf bundle</td>
|
||
<td><code>basics/configuration/index.md</code></td>
|
||
<td><code>basics/configuration</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td>Page</td>
|
||
<td><code>basics/configuration.md</code></td>
|
||
<td><code>basics/configuration</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" target="_blank">Hugo got you covered</a> as well.</p>
|
||
<p>Also, the old themes implementation allowed refs to non-existing content. This will cause Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can <a href="https://gohugo.io/content-management/cross-references/#link-to-another-language-version" target="_blank">reconfigure the error handling</a> of Hugos implementation.</p>
|
||
<p>In the best case your usage of the old implementation is already standard compliant and you don’t need to change anything. You’ll notice this very easily once you’ve started <code>hugo server</code> after an upgrade and no errors are written to the console.</p>
|
||
<p>You may see errors on the console after the update in the 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>: page not found
|
||
</span></span></code></pre></div><p>In this case, you must apply one of two options:</p>
|
||
<ol>
|
||
<li>
|
||
<p>Copy the old implementation files <code>theme/hugo-theme-relearn/layouts/shortcode/ref.html</code> and <code>theme/hugo-theme-relearn/layouts/shortcode/relref.html</code> to your own projects <code>layouts/shortcode/ref.html</code> and <code>layouts/shortcode/relref.html</code> respectively. <strong>This is not recommended</strong> as your project will still rely on non-standard behavior afterwards.</p>
|
||
</li>
|
||
<li>
|
||
<p>Start up a text editor with regular expression support for search and replace. Apply the following conversions in the given order on all <code>*.md</code> files. <strong>This is the 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>Page</td>
|
||
<td><code>(ref\s+"[^"]*)\.md"</code></td>
|
||
<td><code>$1"</code></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="280-2021-11-03">2.8.0 (2021-11-03)</h2>
|
||
<ul>
|
||
<li>
|
||
<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 the font <code>Novacento</code>/<code>Novecento</code>. If you use it in an overwritten CSS please replace it with <code>Work Sans</code>. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for Czech.</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> The theme now supports favicons served from <code>static/images/</code> named as <code>favicon</code> or <code>logo</code> in SVG, PNG or ICO format <a href="./basics/customization/#change-the-favicon">out of the box</a>. An overridden partial <code>layouts/partials/favicon.html</code> may not be necessary anymore in most cases.</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> You can hide the table of contents menu for the whole site by setting the <code>disableToc</code> option in your <code>config.toml</code>. For an example see <a href="./basics/configuration/#global-site-parameters">the example configuration</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="270-2021-10-24">2.7.0 (2021-10-24)</h2>
|
||
<ul>
|
||
<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 for <a href="./shortcodes/notice/"><code>notice</code></a> shortcode to set title in box header.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="260-2021-10-21">2.6.0 (2021-10-21)</h2>
|
||
<ul>
|
||
<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> Your site can now be served from a subfolder if you set <code>baseURL</code> and <code>canonifyURLs=true</code> in your <code>config.toml</code>. See the <a href="./basics/configuration/#a-word-on-running-your-site-in-a-subfolder">documentation</a> for a detailed example.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="250-2021-10-08">2.5.0 (2021-10-08)</h2>
|
||
<ul>
|
||
<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> and <code>--CODE-BLOCK-BG-color</code> were added to provide a fallback for Hugos syntax highlighting in case <code>guessSyntax=true</code> is set. Ideally the colors are set to the same values as the ones from your chosen chroma style.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="240-2021-10-07">2.4.0 (2021-10-07)</h2>
|
||
<ul>
|
||
<li>
|
||
<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> Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included.</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> Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting <code>disableTagHiddenPages=true</code> in your <code>config.toml</code>.</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> You can define the expansion state of your menus for the whole site by setting the <code>alwaysopen</code> option in your <code>config.toml</code>. Please see further <a href="./cont/pages/#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and default behavior.</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> New frontmatter <code>ordersectionsby</code> option to change immediate children sorting in menu and <code>children</code> shortcode. Possible values are <code>title</code> or <code>weight</code>.</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> Alternate content of a page is now advertised in the HTML meta tags. See <a href="https://gohugo.io/templates/rss/#reference-your-rss-feed-in-head" target="_blank">Hugo documentation</a>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="230-2021-09-13">2.3.0 (2021-09-13)</h2>
|
||
<ul>
|
||
<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 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 providing a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Pirates one due to maintenance constraints.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="220-2021-09-09">2.2.0 (2021-09-09)</h2>
|
||
<ul>
|
||
<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 pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting <code>disableSeoHiddenPages=true</code> in your <code>config.toml</code>.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="210-2021-09-07">2.1.0 (2021-09-07)</h2>
|
||
<ul>
|
||
<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.69.0</span></span> This release requires a newer Hugo version.</p>
|
||
</li>
|
||
<li>
|
||
<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 the site’s structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see <code>CHANGELOG.md</code> in the exampleSite), they will now be ignored by the search.</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> Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting <code>disableSearchHiddenPages=true</code> in your <code>config.toml</code>.</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> If a search term is found in an <code>expand</code> shortcode, the expand will be opened.</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> The menu will scroll the active item into view on load.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="200-2021-08-28">2.0.0 (2021-08-28)</h2>
|
||
<ul>
|
||
<li>
|
||
<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> Syntax highlighting was switched to the <a href="https://gohugo.io/content-management/syntax-highlighting/" target="_blank">built in Hugo mechanism</a>. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation</p>
|
||
</li>
|
||
<li>
|
||
<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 the predefined stylesheets there was a typo and <code>--MENU-HOME-LINK-HOVERED-color</code> must be changed to <code>--MENU-HOME-LINK-HOVER-color</code>. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.</p>
|
||
</li>
|
||
<li>
|
||
<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> and <code>--MENU-HOME-LINK-HOVER-color</code> were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.</p>
|
||
</li>
|
||
<li>
|
||
<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 navigation and <code>children</code> shortcode were ignoring setting for <code>ordersectionsby</code>. This is now changed and may result in different sorting order of your sub pages.</p>
|
||
</li>
|
||
<li>
|
||
<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 pages are accessed directly by typing their URL, they will be exposed in the menu.</p>
|
||
</li>
|
||
<li>
|
||
<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 page without a <code>title</code> will be treated as <code>hidden=true</code>.</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> You can define the expansion state of your menus in the frontmatter. Please see further <a href="./cont/pages/#override-expand-state-rules-for-menu-entries">documentation</a> for possible values and default behavior.</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> New partials for defining pre/post content for menu items and the content. See <a href="./basics/customization/">documentation</a> for further reading.</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> Shortcode <a href="./shortcodes/children/"><code>children</code></a> with new parameter <code>containerstyle</code>.</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> New shortcode <a href="./shortcodes/include/"><code>include</code></a> to include arbitrary file content into a page.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="120-2021-07-26">1.2.0 (2021-07-26)</h2>
|
||
<ul>
|
||
<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> with new parameter to open on page load.</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="110-2021-07-02">1.1.0 (2021-07-02)</h2>
|
||
<ul>
|
||
<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">Breaking</span></span> <a href="./shortcodes/mermaid/">Mermaid</a> diagrams can now be panned and zoomed. This isn’t configurable 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>Mermaid</code></a> config options can be set in <code>config.toml</code>.</p>
|
||
</li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="100-2021-07-01">1.0.0 (2021-07-01)</h2>
|
||
<ul>
|
||
<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.65.0</span></span> The requirement for the Hugo version of this theme is the same as for the Learn theme version 2.5.0 on 2021-07-01.</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> Initial fork of the <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn theme</a> based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to <code>Relearn</code> and a new logo. For the reasons behind forking the Learn theme, see <a href="https://github.com/matcornic/hugo-theme-learn/issues/442#issuecomment-907863495" target="_blank">this comment</a> in the Learn issues.</p>
|
||
</li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="requirements">Requirements</h1>
|
||
|
||
<p>Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.</p>
|
||
<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> of the <a href="https://gohugo.io/getting-started/installing/" target="_blank">Hugo binary</a> for your OS (Windows, Linux, Mac).</p>
|
||
<p>
|
||
<a href="#image-a093caf754d76f0bdecfeb0af1bf8594" class="lightbox-link">
|
||
<img src="./basics/requirements/magic.gif?classes=shadow" alt="Magic" class="shadow" style="height: auto; width: auto;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-a093caf754d76f0bdecfeb0af1bf8594">
|
||
<img src="./basics/requirements/magic.gif?classes=shadow" alt="Magic" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="installation">Installation</h1>
|
||
|
||
<p>The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this <a href="https://gohugo.io/overview/quickstart/" target="_blank">great documentation for beginners</a>.</p>
|
||
<h2 id="create-your-project">Create your project</h2>
|
||
<p>Hugo provides a <code>new</code> command to create a new website.</p>
|
||
<pre tabindex="0"><code>hugo new site <new_project>
|
||
</code></pre><h2 id="install-the-theme">Install the theme</h2>
|
||
<p>Install the Relearn theme by following <a href="https://gohugo.io/hugo-modules/use-modules/#use-a-module-for-a-theme" target="_blank">this documentation</a> using Hugo’s module system.</p>
|
||
<p>This theme’s repository is: <a href="https://github.com/McShelby/hugo-theme-relearn.git" target="_blank">https://github.com/McShelby/hugo-theme-relearn.git</a></p>
|
||
<p>Alternatively, you can <a href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" target="_blank">download the theme as .zip</a> file and extract it in the <code>themes</code> directory</p>
|
||
<h3 id="from-git">From Git</h3>
|
||
<p>If you install the theme from your git repository or GitHub, you have several options.</p>
|
||
<p>If you use the <code>head</code> of the <code>main</code> branch, you are using the development version. Usually it is fully functional but can break from time to time. We try to fix newly introduced bugs in this version as soon as possible.</p>
|
||
<p>Additionally you can checkout one of the tagged versions. These tagged versions correspond to an official <a href="https://github.com/McShelby/hugo-theme-relearn/releases" target="_blank">releases from the GitHub repository</a>.</p>
|
||
<p>Besides the usual version tags (eg <code>1.2.3</code>) there are also tags for the main version (eg. <code>1.2.x</code>), major version (eg. <code>1.x</code>) and the latest (just <code>x</code>) released version making it easier for you to pin the theme to a certain version.</p>
|
||
<h2 id="basic-configuration">Basic configuration</h2>
|
||
<p>When building the website, you can set a theme by using <code>--theme</code> option. However, we suggest you modify the configuration file (<code>config.toml</code>) and set the theme as the default. You can also add the <code>[outputs]</code> section to enable the 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 the default theme to be use when building the site with 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>
|
||
</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></span></code></pre></div><h2 id="create-your-first-chapter-page">Create your first chapter page</h2>
|
||
<p>Chapters are pages that contain other child pages. It has a special layout style and usually just contains a <em>chapter name</em>, the <em>title</em> and a <em>brief abstract</em> of the 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 Hugo theme is all about and the core concepts behind it.
|
||
</span></span></code></pre></div><p>renders as</p>
|
||
<p>
|
||
|
||
<a href="#image-ea52295ed136a0884723d8a7c4a14f62" class="lightbox-link">
|
||
<img src="./basics/installation/chapter.png?classes=shadow&width=60pc" alt="A Chapter" class="shadow" style="height: auto; width: 60pc;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-ea52295ed136a0884723d8a7c4a14f62">
|
||
<img src="./basics/installation/chapter.png?classes=shadow&width=60pc" alt="A Chapter" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
<p>The Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following 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 opening the given file, you should see the property <code>chapter=true</code> on top, meaning this page is a <em>chapter</em>.</p>
|
||
<p>By default all chapters and pages are created as a draft. If you want to render these pages, remove the property <code>draft: true</code> from the metadata.</p>
|
||
<h2 id="create-your-first-content-pages">Create your first content pages</h2>
|
||
<p>Then, create content pages inside the previously created chapter. Here are two ways to create content in the 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 to edit those files by adding some sample content and replacing the <code>title</code> value in the beginning of the files.</p>
|
||
<h2 id="launching-the-website-locally">Launching the website locally</h2>
|
||
<p>Launch by using the following 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 to <code>http://localhost:1313</code></p>
|
||
<p>You should notice three things:</p>
|
||
<ol>
|
||
<li>You have a left-side <strong>Basics</strong> menu, containing two submenus with names equal to the <code>title</code> properties in the previously created files.</li>
|
||
<li>The home page explains how to customize it by following the instructions.</li>
|
||
<li>When you run <code>hugo serve</code>, when the contents of the files change, the page automatically refreshes with the changes. Neat!</li>
|
||
</ol>
|
||
<h2 id="build-the-website">Build the website</h2>
|
||
<p>When your site is ready to deploy, run the following 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, containing all static content and assets for your website. It can now be deployed on any web server.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>This website can be automatically published and hosted with <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 with Netlify</a>). Alternatively, you can use <a href="https://gohugo.io/hosting-and-deployment/hosting-on-github/" target="_blank">GitHub pages</a>.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="configuration">Configuration</h1>
|
||
|
||
<h2 id="global-site-parameters">Global site parameters</h2>
|
||
<p>On top of <a href="https://gohugo.io/overview/configuration/" target="_blank">Hugo global configuration</a>, the Relearn theme lets you define the following parameters in your <code>config.toml</code> (here, values are default).</p>
|
||
<p>Note that some of these parameters are explained in details in other sections of this documentation.</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) in the</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># menu; if no setting is given, the first menu level is set to false, all others to true;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># this can be overridden in the pages 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 to edit current page. Will display an "Edit" button on top right hand corner of every page.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Useful to give opportunity to people to create merge request for your doc.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># See the config.toml file from this documentation site to 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 of the site, will be used in meta information</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"># Description of the site, will be used in meta information</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">description</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Shows a checkmark for visited pages on the 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"># Disable search function. 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"># Disable search in hidden pages, otherwise they will be shown in 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 pages from showing up in the sitemap and 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 pages from showing up on the tags page although the tag term will be displayed even if all pages are 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 and CSS cache are automatically busted when new version of site is generated.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Set this to true to disable this behavior (some proxies don't handle well this optimization)</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableAssetsBusting</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Set this to true if you want to disable generation for generator version meta tags of hugo and the theme;</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># don't forget to also set Hugo's disableHugoGeneratorInject=true, otherwise it will generate a meta tag into your home page</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableGeneratorVersion</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Set this to true to disable copy-to-clipboard button for 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 for shortcuts in menu is set by default. Set this to true to disable 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 to false, a Home button will appear below the search bar on the menu.</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># It is redirecting to the landing page of the current language if specified. (Default is "/")</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 using mulitlingual website, disable the 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 in the header and only show the current page 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 to true, hide table of contents menu in the header of all pages</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 to false, load the MathJax module on every page regardless if a MathJax shortcode is present</span>
|
||
</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 the remote location of the 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"># Initialization parameter for MathJax, see MathJax documentation</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mathJaxInitialize</span> <span class="p">=</span> <span class="s2">"{}"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present</span>
|
||
</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 the remote location of the Mermaid 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"># Initialization parameter for Mermaid, see Mermaid documentation</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s2">"{ \"theme\": \"default\" }"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If set to false, load the OpenAPI module on every page regardless if a OpenAPI shortcode is present</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">disableOpenapi</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Specifies the remote location of the swagger-ui js</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">customOpenapiURL</span> <span class="p">=</span> <span class="s2">"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Hide Next and Previous page buttons normally displayed full height beside content</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 in menu by "weight" or "title". Default to "weight";</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># this can be overridden in the pages frontmatter</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">ordersectionsby</span> <span class="p">=</span> <span class="s2">"weight"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Change default color scheme with 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>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># Change the title separator. Default to "::".</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">titleSeparator</span> <span class="p">=</span> <span class="s2">"-"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If set to true, the menu in the sidebar will be displayed in a collapsible tree view. Although the functionality works with old browsers (IE11), the display of the expander icons is limited to modern browsers</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">collapsibleMenu</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If a single page can contain content in 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>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># If set to true, no index.html will be appended to prettyURLs; this will cause pages not</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># to be servable from the 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>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># For external links you can define how they are opened in your browser; this setting will only be applied to the content area but not the 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>
|
||
</span></span></code></pre></div><h2 id="serving-your-page-from-a-subfolder">Serving your page from a subfolder</h2>
|
||
<p>If your site is served from a subfolder, eg. <code>https://example.com/mysite/</code>, you have to set the following lines to your <code>config.toml</code></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="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>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span></code></pre></div><p>Without <code>canonifyURLs=true</code> URLs in sublemental pages (like <code>sitemap.xml</code>, <code>rss.xml</code>) will be generated falsly while your 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>
|
||
<h2 id="serving-your-page-from-the-filesystem">Serving your page from the filesystem</h2>
|
||
<p>If you want your page served from the filesystem by using URLs starting with <code>file://</code> you’ll need the following configuration in your <code>config.toml</code>:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">relativeURLs</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span></code></pre></div><p>The theme will append an additional <code>index.html</code> to all branch bundle links by default to make the page be servable from the file system. If you don’t care about the file system and only serve your page via a webserver you can also generate the links without this change by adding this to your <code>config.toml</code></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">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>
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>If you want to use the search feature from the file system using an older installation of the theme make sure to change your outputformat for the homepage from the now deprecated <code>JSON</code> to <code>SEARCH</code> <a href="#activate-search">as seen below</a>.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="activate-search">Activate search</h2>
|
||
<p>If not already present, add the following lines in the same <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></span></code></pre></div><p>This will generate a search index file at the root of your public folder ready to be consumed by the Lunr search library. Note that the <code>SEARCH</code> outputformat was named <code>JSON</code> in previous releases but was implemented differently. Although <code>JSON</code> still works, it is now deprecated.</p>
|
||
<h3 id="activate-dedicated-search-page">Activate dedicated search page</h3>
|
||
<p>You can add a dedicated search page for your page by adding the <code>SEARCHPAGE</code> outputformat to your home page by adding the following lines in your <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>You can access this page by either clicking on the magnifier glass or by typing some search term and pressing <code>ENTER</code> inside of the menu’s search box .</p>
|
||
<p>
|
||
|
||
<a href="#image-5cf2e5d47a5991de86a3a5637bbe969a" class="lightbox-link">
|
||
<img src="./basics/configuration/search_page.png?&width=60pc" alt="Screenshot of the dedicated search page" style="height: auto; width: 60pc;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-5cf2e5d47a5991de86a3a5637bbe969a">
|
||
<img src="./basics/configuration/search_page.png?&width=60pc" alt="Screenshot of the dedicated search page" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
<h2 id="activate-print-support">Activate print support</h2>
|
||
<p>You can activate print support to add the capability to print whole chapters or even the complete site. Just add the <code>PRINT</code> output format to your home, section and page in your <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>
|
||
</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>
|
||
</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">page</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 icon in the top bar. It will switch the page to print preview when clicked. You can then send this page to the printer by using your browser’s usual print functionality.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>The resulting URL will not be <a href="https://gohugo.io/templates/output-formats/#configure-output-formats" target="_blank">configured ugly</a> in terms of <a href="https://gohugo.io/content-management/urls/#ugly-urls" target="_blank">Hugo’s URL handling</a> even if you’ve set <code>uglyURLs=true</code> in your <code>config.toml</code>. This is due to the fact that for one mime type only one suffix can be configured.</p>
|
||
<p>Nevertheless, if you’re unhappy with the resulting URLs you can manually redefine <code>outputFormats.PRINT</code> in your own <code>config.toml</code> to your liking.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="mathjax">MathJax</h2>
|
||
<p>The MathJax configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See <a href="./shortcodes/math/">Math</a> for additional documentation.</p>
|
||
<h3 id="math-example">Example</h3>
|
||
<p>MathJax is globally disabled. By default it won’t be loaded by any page.</p>
|
||
<p>On page “Physics” you coded some JavaScript for a dynamic formulae. You can set the MathJax parameters locally to load mathJax on this page.</p>
|
||
<p>You also can disable MathJax for specific pages while globally enabled.</p>
|
||
<h2 id="mermaid">Mermaid</h2>
|
||
<p>The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See <a href="./shortcodes/mermaid/">Mermaid</a> for additional documentation.</p>
|
||
<h3 id="mermaid-example">Example</h3>
|
||
<p>Mermaid is globally disabled. By default it won’t be loaded by any page.</p>
|
||
<p>On page “Architecture” you coded some JavaScript to dynamically generate a class diagram. You can set the Mermaid parameters locally to load mermaid on this page.</p>
|
||
<p>You also can disable Mermaid for specific pages while globally enabled.</p>
|
||
<h2 id="home-button-configuration">Home Button Configuration</h2>
|
||
<p>If the <code>disableLandingPageButton</code> option is set to <code>false</code>, a Home button will appear
|
||
on the left menu. It is an alternative for clicking on the logo. To edit the
|
||
appearance, you will have to configure two parameters for the 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="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">params</span><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="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">params</span><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 are not configured for a specific language, they will get their
|
||
default values:</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">landingPageName</span> <span class="p">=</span> <span class="s2">"<i class='fas fa-home'></i> Home"</span>
|
||
</span></span></code></pre></div><p>The home button is going to look like this:</p>
|
||
<p>
|
||
|
||
<a href="#image-5899b3822c229954e5f5dca31b6c044f" class="lightbox-link">
|
||
<img src="./basics/configuration/home_button_defaults.png?classes=shadow&width=18.75rem" alt="Default Home Button" class="shadow" style="height: auto; width: 18.75rem;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-5899b3822c229954e5f5dca31b6c044f">
|
||
<img src="./basics/configuration/home_button_defaults.png?classes=shadow&width=18.75rem" alt="Default Home Button" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="customization">Customization</h1>
|
||
|
||
<p>The Relearn theme has been built to be as configurable as possible by defining multiple <a href="https://gohugo.io/templates/partials/" target="_blank">partials</a></p>
|
||
<p>In <code>themes/hugo-theme-relearn/layouts/partials/</code>, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead <a href="https://gohugo.io/themes/customizing/" target="_blank">follow this page</a>. You’d create a new partial in the <code>layouts/partials</code> folder of your local project. This partial will have the priority.</p>
|
||
<p>This theme defines the following partials :</p>
|
||
<ul>
|
||
<li><code>header.html</code>: the header of the page. See <a href="#output-formats">output-formats</a></li>
|
||
<li><code>footer.html</code>: the footer of the page. See <a href="#output-formats">output-formats</a></li>
|
||
<li><code>body.html</code>: the body of the page. The body may contain of one or many articles. See <a href="#output-formats">output-formats</a></li>
|
||
<li><code>article.html</code>: the output for a single article, can contain elements around your content. See <a href="#output-formats">output-formats</a></li>
|
||
<li><code>menu.html</code>: left menu. <em>Not meant to be overwritten</em></li>
|
||
<li><code>search.html</code>: search box. <em>Not meant to be overwritten</em></li>
|
||
<li><code>custom-header.html</code>: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include <code>style</code> HTML tag directive in your file.</li>
|
||
<li><code>custom-footer.html</code>: custom footer in page. Meant to be overwritten when adding JavaScript. Don’t forget to include <code>javascript</code> HTML tag directive in your file.</li>
|
||
<li><code>favicon.html</code>: the favicon</li>
|
||
<li><code>heading-pre.html</code>: side-wide configuration to prepend to pages title headings. If you override this, it is your responsibility to take the page’s <code>headingPre</code> setting into account.</li>
|
||
<li><code>heading-post.html</code>: side-wide configuration to append to pages title headings. If you override this, it is your responsibility to take the page’s <code>headingPost</code> setting into account.</li>
|
||
<li><code>logo.html</code>: the logo, on top left hand corner</li>
|
||
<li><code>meta.html</code>: HTML meta tags, if you want to change default behavior</li>
|
||
<li><code>menu-pre.html</code>: side-wide configuration to prepend to menu items. If you override this, it is your responsibility to take the page’s <code>menuPre</code> setting into account.</li>
|
||
<li><code>menu-post.html</code>: side-wide configuration to append to menu items. If you override this, it is your responsibility to take the page’s <code>menuPost</code> setting into account.</li>
|
||
<li><code>menu-footer.html</code>: footer of the the left menu</li>
|
||
<li><code>toc.html</code>: table of contents</li>
|
||
<li><code>content.html</code>: the content page itself. This can be overridden if you want to display page’s meta data above or below the content.</li>
|
||
<li><code>content-footer</code>: footer below the content, has a default implementation but you can overwrite it if you don’t like it.</li>
|
||
</ul>
|
||
<h2 id="change-the-logo">Change the logo</h2>
|
||
<p>Create a new file in <code>layouts/partials/</code> named <code>logo.html</code>. Then write any HTML you want.
|
||
You could use an <code>img</code> HTML tag and reference an image created under the <em>static</em> folder, or you could paste a SVG definition!</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>The size of the logo will adapt automatically</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="change-the-favicon">Change the favicon</h2>
|
||
<p>If your favicon is a SVG, PNG or ICO, just drop off your image in your local <code>static/images/</code> folder and name it <code>favicon.svg</code>, <code>favicon.png</code> or <code>favicon.ico</code> respectively.</p>
|
||
<p>If no favicon file is found, the theme will lookup the alternative filename <code>logo</code> in the same location and will repeat the search for the list of supported file types.</p>
|
||
<p>If you need to change this default behavior, create a new file in <code>layouts/partials/</code> named <code>favicon.html</code>. Then write something 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">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>
|
||
</span></span></code></pre></div><h2 id="theme-variant">Change the colors</h2>
|
||
<p>The Relearn theme lets you choose between some predefined color variants in light or dark mode, but feel free to add one yourself!</p>
|
||
<p>You can preview the shipped variants by changing them in the variant selector at the bottom of the menu.</p>
|
||
<h3 id="single-variant">Single variant</h3>
|
||
<p>Set the <code>themeVariant</code> value with the name of your 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>
|
||
</span></span></code></pre></div><p>In the above example your theme file has to be named <code>theme-relearn-light.css</code></p>
|
||
<h3 id="multiple-variants">Multiple variants</h3>
|
||
<p>You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant switch will be shown in the menu footer.</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"># Change default color scheme with 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>
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
<p>If you want to switch the syntax highlighting theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation <a href="https://gohugo.io/content-management/syntax-highlighting/" target="_blank">according to Hugo’s documentation</a>, and <code>@import</code> this stylesheet in your color variant stylesheet. For an example, take a look into <code>theme-relearn-light.css</code> and <code>config.toml</code> of the exampleSite.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="adjust-to-os-settings">Adjust to OS Settings</h3>
|
||
<p>You can also cause the site to adjust to your OS settings for light/dark mode. Just set the <code>themeVariant</code> to <code>auto</code>. That’s it.</p>
|
||
<p>If you’ve set multiple variants, you can drop <code>auto</code> at any position, but usually it makes sense to set it in the first position and make it the 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 you don’t configure anything else, the theme will use <code>relearn-light</code> for light mode and <code>relearn-dark</code> for dark mode.</p>
|
||
<p>If you don’t like that, you can set <code>themeVariantAuto</code>. The first element is the variant for light mode, the second for 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>
|
||
</span></span></code></pre></div>
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>This is not supported for Internet Explorer 11, which still displays in the <code>relearn-light</code> variant.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="roll-your-own">Roll your own</h3>
|
||
<p>If you are not happy with the shipped variants you can either copy and rename one of the shipped files from <code>themes/hugo-theme-relearn/static/css</code> to <code>static/css</code>, edit them afterwards to your liking in a text editor and configure the <code>themeVariant</code> parameter in your <code>config.toml</code> or just use the <a href="./basics/generator/">interactive variant generator</a>.</p>
|
||
<h3 id="output-formats">Output formats</h3>
|
||
<p>Certain parts of the theme can be changed for support of your own <a href="https://gohugo.io/templates/output-formats/" target="_blank">output formats</a>. Eg. if you define a new output format <code>PLAINTEXT</code> in your <code>config.toml</code>, you can add a file <code>layouts/partials/header.plaintext.html</code> to change the way, the page header should look like for that output format.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="stylesheet-generator">Stylesheet generator</h1>
|
||
|
||
<p>This interactive tool may help you to generate your own color variant stylesheet.</p>
|
||
|
||
<div class="expand">
|
||
<input type="checkbox" id="expand-cc7151f67141d7d0f5b9dba658b5da76" aria-controls="expandcontent-cc7151f67141d7d0f5b9dba658b5da76" >
|
||
<label class="expand-label" for="expand-cc7151f67141d7d0f5b9dba658b5da76" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Show usage instructions
|
||
</label>
|
||
<div id="expandcontent-cc7151f67141d7d0f5b9dba658b5da76" class="expand-content">
|
||
<p>To get started, first select a color variant from the variant switch in the lower left sidebar that fits you best as a starting point.</p>
|
||
<p>The graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph <strong>and the page</strong> will update accordingly.</p>
|
||
<p>The arrowed lines reflect how colors are inherited thru different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.</p>
|
||
<p>To better understand this select the <code>neon</code> variant and modify the different heading colors. There, colors for the heading <code>h2</code>, <code>h3</code> and <code>h4</code> are explicitly set. <code>h5</code> is not set and inherits its value from <code>h4</code>. <code>h6</code> is also not set and inherits its value from <code>h5</code>.</p>
|
||
<p>Once you’ve changed a color, the variant switch will show a “My custom variant” entry and your changes are stored in the browser. You can <strong>browse to other pages</strong> and even close the browser <strong>without losing your changes</strong>.</p>
|
||
<p>Once you are satisfied, you can download the new variants file and copy it into your site’s <code>static/css</code> directory. Afterwards you have to adjust the <code>themeVariant</code> parameter in your <code>config.toml</code> to your chosen file name.</p>
|
||
<p>Eg. if your new variants file is named <code>theme-my-custom-variant.css</code>, you have to set <code>themeVariant='my-custom-variant'</code> to use it.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<p>
|
||
<span class="btn cstyle secondary">
|
||
<button onclick="window.variants&&variants.getStylesheet();this.blur();" type="button">
|
||
<i class="fa-fw fas fa-download"></i>
|
||
Download variant
|
||
</button>
|
||
</span>
|
||
|
||
<span class="btn cstyle warning">
|
||
<button onclick="window.variants&&variants.resetVariant();this.blur();" type="button">
|
||
<i class="fa-fw fas fa-trash"></i>
|
||
Reset variant
|
||
</button>
|
||
</span></p>
|
||
<div id="vargenerator" class="mermaid" style="background-color: var(--INTERNAL-MAIN-TEXT-color);">Graph</div>
|
||
<p>
|
||
<span class="btn cstyle secondary">
|
||
<button onclick="window.variants&&variants.getStylesheet();this.blur();" type="button">
|
||
<i class="fa-fw fas fa-download"></i>
|
||
Download variant
|
||
</button>
|
||
</span>
|
||
|
||
<span class="btn cstyle warning">
|
||
<button onclick="window.variants&&variants.resetVariant();this.blur();" type="button">
|
||
<i class="fa-fw fas fa-trash"></i>
|
||
Reset variant
|
||
</button>
|
||
</span></p>
|
||
<script>
|
||
window.variants && variants.generator( '#vargenerator' );
|
||
</script>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="history">History</h1>
|
||
|
||
<div class="include hide-first-heading">
|
||
<h1 id="changelog">Changelog</h1>
|
||
<h2 id="5131-2023-05-16">5.13.1 (2023-05-16)</h2>
|
||
<h3 id="fixes">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] openapi: allow toc to scroll page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/526" target="_blank">#526</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5130-2023-05-14">5.13.0 (2023-05-14)</h2>
|
||
<h3 id="enhancements">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] openapi: replace implementation with swagger-ui <a href="https://github.com/McShelby/hugo-theme-relearn/issues/523" target="_blank">#523</a></li>
|
||
</ul>
|
||
<h3 id="fixes-1">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: avoid leaking shadows in neon print style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/524" target="_blank">#524</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5126-2023-05-04">5.12.6 (2023-05-04)</h2>
|
||
<h3 id="enhancements-1">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: better HTML titles and breadcrumbs for search and tag pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/521" target="_blank">#521</a></li>
|
||
</ul>
|
||
<h3 id="fixes-2">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: avoid hiding of expander on hover when active item has children <a href="https://github.com/McShelby/hugo-theme-relearn/issues/520" target="_blank">#520</a></li>
|
||
<li>[<strong>bug</strong>] menu: showVisitedLinks not working for some theme variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/518" target="_blank">#518</a></li>
|
||
<li>[<strong>bug</strong>] theme: fix resource URLs for 404 page on subdirectories <a href="https://github.com/McShelby/hugo-theme-relearn/issues/515" target="_blank">#515</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5125-2023-03-28">5.12.5 (2023-03-28)</h2>
|
||
<h3 id="fixes-3">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] expand: not properly exanded when used in bullet point list <a href="https://github.com/McShelby/hugo-theme-relearn/issues/508" target="_blank">#508</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5124-2023-03-24">5.12.4 (2023-03-24)</h2>
|
||
<h3 id="fixes-4">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: disableExplicitIndexURLs param is not working as expected <a href="https://github.com/McShelby/hugo-theme-relearn/issues/505" target="_blank">#505</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5123-2023-03-14">5.12.3 (2023-03-14)</h2>
|
||
<h3 id="fixes-5">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: fix links if only one language is present <a href="https://github.com/McShelby/hugo-theme-relearn/issues/503" target="_blank">#503</a></li>
|
||
<li>[<strong>bug</strong>] shortcodes: allow markdown for title and content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/502" target="_blank">#502</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5122-2023-03-03">5.12.2 (2023-03-03)</h2>
|
||
<h3 id="fixes-6">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: fix state for alwaysopen=false + collapsibleMenu=false <a href="https://github.com/McShelby/hugo-theme-relearn/issues/498" target="_blank">#498</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5121-2023-02-26">5.12.1 (2023-02-26)</h2>
|
||
<h3 id="enhancements-2">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] variant: add relearn bright theme <a href="https://github.com/McShelby/hugo-theme-relearn/issues/493" target="_blank">#493</a></li>
|
||
</ul>
|
||
<h3 id="fixes-7">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] generator: fix setting of colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/494" target="_blank">#494</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5120-2023-02-24">5.12.0 (2023-02-24)</h2>
|
||
<h3 id="enhancements-3">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] frontmatter: support VSCode Front Matter extension <a href="https://github.com/McShelby/hugo-theme-relearn/issues/481" target="_blank">#481</a></li>
|
||
<li>[<strong>feature</strong>] theme: make expand and image ids stable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/477" target="_blank">#477</a></li>
|
||
<li>[<strong>feature</strong>] variant: set scrollbar color to dark for dark variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/471" target="_blank">#471</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add full RTL support <a href="https://github.com/McShelby/hugo-theme-relearn/issues/470" target="_blank">#470</a></li>
|
||
<li>[<strong>feature</strong>] piratify: fix some quirks, arrr <a href="https://github.com/McShelby/hugo-theme-relearn/issues/469" target="_blank">#469</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: optimization for huge screen sizes <a href="https://github.com/McShelby/hugo-theme-relearn/issues/466" target="_blank">#466</a></li>
|
||
</ul>
|
||
<h3 id="fixes-8">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] i18n: write code ltr even for rtl languages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/492" target="_blank">#492</a></li>
|
||
<li>[<strong>bug</strong>] anchor: fix link in FF when served from filesystem <a href="https://github.com/McShelby/hugo-theme-relearn/issues/482" target="_blank">#482</a></li>
|
||
<li>[<strong>bug</strong>] shortcodes: don’t break build and render for invalid parameters <a href="https://github.com/McShelby/hugo-theme-relearn/issues/480" target="_blank">#480</a></li>
|
||
<li>[<strong>bug</strong>] nav: restore scroll position on browser back <a href="https://github.com/McShelby/hugo-theme-relearn/issues/476" target="_blank">#476</a></li>
|
||
<li>[<strong>bug</strong>] variant: avoid style leak for auto style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/473" target="_blank">#473</a></li>
|
||
</ul>
|
||
<h3 id="maintenance">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: add imagebot <a href="https://github.com/McShelby/hugo-theme-relearn/issues/485" target="_blank">#485</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5112-2023-02-07">5.11.2 (2023-02-07)</h2>
|
||
<h3 id="fixes-9">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tabs: nested tabs content is 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-10">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: include missing <code>theme-auto.css</code> in distribution <a href="https://github.com/McShelby/hugo-theme-relearn/issues/467" target="_blank">#467</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5110-2023-02-05">5.11.0 (2023-02-05)</h2>
|
||
<h3 id="enhancements-4">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Czech translation <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 to CSS-only solution <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 for <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 for a11y <a href="https://github.com/McShelby/hugo-theme-relearn/issues/339" target="_blank">#339</a></li>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] mermaid: make zoom configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/144" target="_blank">#144</a></li>
|
||
</ul>
|
||
<h3 id="fixes-11">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: avoid errors when using 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 in keyboard handling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/463" target="_blank">#463</a></li>
|
||
<li>[<strong>bug</strong>] badge: fix text color for 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 is present and variant is 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 pages 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 double slash on root page link <a href="https://github.com/McShelby/hugo-theme-relearn/issues/450" target="_blank">#450</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-1">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: add moving 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 for 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>
|
||
<h3 id="fixes-12">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: fix breadcrumb for huge installations <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>
|
||
<h3 id="fixes-13">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix image links with relative path <a href="https://github.com/McShelby/hugo-theme-relearn/issues/444" target="_blank">#444</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="5100-2023-01-25">5.10.0 (2023-01-25)</h2>
|
||
<h3 id="enhancements-5">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] shortcodes: support for accent color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/440" target="_blank">#440</a></li>
|
||
<li>[<strong>feature</strong>] shortcodes: add color parameter where applicable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/438" target="_blank">#438</a></li>
|
||
<li>[<strong>feature</strong>] theme: announce translations as alternate links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/422" target="_blank">#422</a></li>
|
||
</ul>
|
||
<h3 id="fixes-14">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: fix breadcrumbs for 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 whitespacing in 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>
|
||
<h3 id="fixes-15">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix search icon and 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>
|
||
<h3 id="fixes-16">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] nav: fix left/right navigation for horizontal scrolling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/435" target="_blank">#435</a></li>
|
||
<li>[<strong>bug</strong>] theme: allow pages on top level <a href="https://github.com/McShelby/hugo-theme-relearn/issues/434" target="_blank">#434</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-2">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: switch to wildcard version of actions <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>
|
||
<h3 id="fixes-17">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: apply dependency scripts for Hindi and Japanese <a href="https://github.com/McShelby/hugo-theme-relearn/issues/427" target="_blank">#427</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="591-2022-12-23">5.9.1 (2022-12-23)</h2>
|
||
<h3 id="enhancements-6">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: make external link target configurable <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>
|
||
<h3 id="enhancements-7">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: open external links in 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 Hugo module <a href="https://github.com/McShelby/hugo-theme-relearn/issues/417" target="_blank">#417</a></li>
|
||
</ul>
|
||
<h3 id="fixes-18">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] attachments: fix incorrect links for defaultContentLanguageInSubdir=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/425" target="_blank">#425</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="581-2022-12-11">5.8.1 (2022-12-11)</h2>
|
||
<h3 id="fixes-19">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix alias for home page if defaultContentLanguageInSubdir=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/414" target="_blank">#414</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="580-2022-12-08">5.8.0 (2022-12-08)</h2>
|
||
<h3 id="enhancements-8">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] icon: add new shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/412" target="_blank">#412</a></li>
|
||
<li>[<strong>feature</strong>] theme: style and document markdown extensions <a href="https://github.com/McShelby/hugo-theme-relearn/issues/411" target="_blank">#411</a></li>
|
||
<li>[<strong>feature</strong>] badge: add new shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/410" target="_blank">#410</a></li>
|
||
<li>[<strong>feature</strong>] theme: add accent color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/409" target="_blank">#409</a></li>
|
||
</ul>
|
||
<h3 id="fixes-20">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix spacing for tag flyout in FF <a href="https://github.com/McShelby/hugo-theme-relearn/issues/413" target="_blank">#413</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="570-2022-11-29">5.7.0 (2022-11-29)</h2>
|
||
<h3 id="enhancements-9">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] button: refactor for a11y <a href="https://github.com/McShelby/hugo-theme-relearn/issues/372" target="_blank">#372</a></li>
|
||
</ul>
|
||
<h3 id="fixes-21">Fixes</h3>
|
||
<ul>
|
||
<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 in FF and 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 translation from country to lang code <a href="https://github.com/McShelby/hugo-theme-relearn/issues/404" target="_blank">#404</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-3">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] search: update lunr languages to 1.10.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/403" target="_blank">#403</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="566-2022-11-23">5.6.6 (2022-11-23)</h2>
|
||
<h3 id="enhancements-10">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] search: make build and js forgiving against config errors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/400" target="_blank">#400</a></li>
|
||
</ul>
|
||
<h3 id="fixes-22">Fixes</h3>
|
||
<ul>
|
||
<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 for use of neon <a href="https://github.com/McShelby/hugo-theme-relearn/issues/401" target="_blank">#401</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="565-2022-11-19">5.6.5 (2022-11-19)</h2>
|
||
<h3 id="fixes-23">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: relax usage of background color <a href="https://github.com/McShelby/hugo-theme-relearn/issues/399" target="_blank">#399</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="564-2022-11-19">5.6.4 (2022-11-19)</h2>
|
||
<h3 id="fixes-24">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: make alias pages usable by file:// protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/398" target="_blank">#398</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="563-2022-11-19">5.6.3 (2022-11-19)</h2>
|
||
<h3 id="fixes-25">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: be compatible with Hugo >= 0.95.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/397" target="_blank">#397</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="562-2022-11-19">5.6.2 (2022-11-19)</h2>
|
||
<h3 id="fixes-26">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: build breaks sites without “output” section in config <a href="https://github.com/McShelby/hugo-theme-relearn/issues/396" target="_blank">#396</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="561-2022-11-19">5.6.1 (2022-11-19)</h2>
|
||
<h3 id="fixes-27">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix image distortion <a href="https://github.com/McShelby/hugo-theme-relearn/issues/395" target="_blank">#395</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="560-2022-11-18">5.6.0 (2022-11-18)</h2>
|
||
<h3 id="enhancements-11">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] toc: improve keyboard handling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/390" target="_blank">#390</a></li>
|
||
<li>[<strong>feature</strong>] search: improve keyboard handling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/387" target="_blank">#387</a></li>
|
||
<li>[<strong>feature</strong>] search: add dedicated search page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/386" target="_blank">#386</a></li>
|
||
<li>[<strong>feature</strong>] theme: make creation of generator meta tag configurable <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>
|
||
</ul>
|
||
<h3 id="fixes-28">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: avoid leading 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 referencing SVGs in markdown <a href="https://github.com/McShelby/hugo-theme-relearn/issues/393" target="_blank">#393</a></li>
|
||
<li>[<strong>bug</strong>] variant: avoid neon to 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 for file:// protocol in sitemap <a href="https://github.com/McShelby/hugo-theme-relearn/issues/385" target="_blank">#385</a></li>
|
||
<li>[<strong>bug</strong>] theme: add id to 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 of 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 navigation when pressing wrong modifiers <a href="https://github.com/McShelby/hugo-theme-relearn/issues/379" target="_blank">#379</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-4">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update to version 9.2.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/391" target="_blank">#391</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="553-2022-11-10">5.5.3 (2022-11-10)</h2>
|
||
<h3 id="fixes-29">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: fix non-latin tag display on pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/378" target="_blank">#378</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="552-2022-11-08">5.5.2 (2022-11-08)</h2>
|
||
<h3 id="fixes-30">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix typo in 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 and children to be served by file:// protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/375" target="_blank">#375</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="551-2022-11-07">5.5.1 (2022-11-07)</h2>
|
||
<h3 id="fixes-31">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix overflowing issue with anchors and tooltips <a href="https://github.com/McShelby/hugo-theme-relearn/issues/364" target="_blank">#364</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="550-2022-11-06">5.5.0 (2022-11-06)</h2>
|
||
<h3 id="enhancements-12">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] theme: optimize page load for images <a href="https://github.com/McShelby/hugo-theme-relearn/issues/304" target="_blank">#304</a></li>
|
||
</ul>
|
||
<h3 id="fixes-32">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix context in 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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="543-2022-11-05">5.4.3 (2022-11-05)</h2>
|
||
<h3 id="enhancements-13">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] history: refactor for a11y <a href="https://github.com/McShelby/hugo-theme-relearn/issues/341" target="_blank">#341</a></li>
|
||
</ul>
|
||
<h3 id="fixes-33">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix multilang links when site served from subdirectory <a href="https://github.com/McShelby/hugo-theme-relearn/issues/370" target="_blank">#370</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="542-2022-11-05">5.4.2 (2022-11-05)</h2>
|
||
<h3 id="maintenance-5">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] build: change set-output to env vars <a href="https://github.com/McShelby/hugo-theme-relearn/issues/348" target="_blank">#348</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="541-2022-11-05">5.4.1 (2022-11-05)</h2>
|
||
<h3 id="fixes-34">Fixes</h3>
|
||
<ul>
|
||
<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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="540-2022-11-01">5.4.0 (2022-11-01)</h2>
|
||
<h3 id="enhancements-14">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] math: allow passing of parameters with codefence syntax <a href="https://github.com/McShelby/hugo-theme-relearn/issues/363" target="_blank">#363</a></li>
|
||
<li>[<strong>feature</strong>] i18n: add Finnish translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/361" target="_blank">#361</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: allow passing of parameters with codefence syntax <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 option for 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 to be served by file:// protocol <a href="https://github.com/McShelby/hugo-theme-relearn/issues/349" target="_blank">#349</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="533-2022-10-09">5.3.3 (2022-10-09)</h2>
|
||
<h3 id="fixes-35">Fixes</h3>
|
||
<ul>
|
||
<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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="532-2022-10-08">5.3.2 (2022-10-08)</h2>
|
||
<h3 id="fixes-36">Fixes</h3>
|
||
<ul>
|
||
<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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="531-2022-10-08">5.3.1 (2022-10-08)</h2>
|
||
<h3 id="enhancements-15">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: update Spanish translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/343" target="_blank">#343</a></li>
|
||
<li>[<strong>feature</strong>] theme: option to align images <a href="https://github.com/McShelby/hugo-theme-relearn/issues/327" target="_blank">#327</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="530-2022-10-07">5.3.0 (2022-10-07)</h2>
|
||
<h3 id="enhancements-16">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] expander: improve whitespace between label and content <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>
|
||
</ul>
|
||
<h3 id="fixes-37">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix links of 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>page</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 in 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 where applicable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/307" target="_blank">#307</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="524-2022-10-02">5.2.4 (2022-10-02)</h2>
|
||
<h3 id="fixes-38">Fixes</h3>
|
||
<ul>
|
||
<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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="523-2022-09-12">5.2.3 (2022-09-12)</h2>
|
||
<h3 id="fixes-39">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: chapter pages overwrite font-size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/328" target="_blank">#328</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="522-2022-08-23">5.2.2 (2022-08-23)</h2>
|
||
<h3 id="fixes-40">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: fix urls for uglyURLs=true <a href="https://github.com/McShelby/hugo-theme-relearn/issues/322" target="_blank">#322</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="521-2022-08-05">5.2.1 (2022-08-05)</h2>
|
||
<h3 id="enhancements-17">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: improve Japanese translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/318" target="_blank">#318</a></li>
|
||
</ul>
|
||
<h3 id="fixes-41">Fixes</h3>
|
||
<ul>
|
||
<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>
|
||
</ul>
|
||
<h3 id="maintenance-6">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] task: bump Hugo minimum requirement to 0.95 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/319" target="_blank">#319</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="520-2022-08-03">5.2.0 (2022-08-03)</h2>
|
||
<h3 id="enhancements-18">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] menu: expand collapsed menus if search term is found in submenus <a href="https://github.com/McShelby/hugo-theme-relearn/issues/312" target="_blank">#312</a></li>
|
||
</ul>
|
||
<h3 id="fixes-42">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: switch mermaid and 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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="512-2022-07-18">5.1.2 (2022-07-18)</h2>
|
||
<h3 id="fixes-43">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] print: reset mermaid theme to light <a href="https://github.com/McShelby/hugo-theme-relearn/issues/313" target="_blank">#313</a></li>
|
||
<li>[<strong>bug</strong>] mermaid: header is showing up in FF <a href="https://github.com/McShelby/hugo-theme-relearn/issues/311" target="_blank">#311</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="511-2022-07-15">5.1.1 (2022-07-15)</h2>
|
||
<h3 id="fixes-44">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] tags: don’t count tags if page is hidden <a href="https://github.com/McShelby/hugo-theme-relearn/issues/310" target="_blank">#310</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="510-2022-07-15">5.1.0 (2022-07-15)</h2>
|
||
<h3 id="enhancements-19">Enhancements</h3>
|
||
<ul>
|
||
<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 overriding partials for output formats <a href="https://github.com/McShelby/hugo-theme-relearn/issues/308" target="_blank">#308</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="503-2022-07-07">5.0.3 (2022-07-07)</h2>
|
||
<h3 id="fixes-45">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] ie11: no styles after rework of archetypes <a href="https://github.com/McShelby/hugo-theme-relearn/issues/306" target="_blank">#306</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="502-2022-07-07">5.0.2 (2022-07-07)</h2>
|
||
<h3 id="fixes-46">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: load CSS if JS is disabled <a href="https://github.com/McShelby/hugo-theme-relearn/issues/305" target="_blank">#305</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="501-2022-07-07">5.0.1 (2022-07-07)</h2>
|
||
<h3 id="enhancements-20">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: optimize loading of js and css <a href="https://github.com/McShelby/hugo-theme-relearn/issues/303" target="_blank">#303</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="500-2022-07-05">5.0.0 (2022-07-05)</h2>
|
||
<h3 id="enhancements-21">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] archetypes: modularize rendering <a href="https://github.com/McShelby/hugo-theme-relearn/issues/300" target="_blank">#300</a></li>
|
||
<li>[<strong>feature</strong>] history: don’t reload page 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 content with topbar icon limits <a href="https://github.com/McShelby/hugo-theme-relearn/issues/290" target="_blank">#290</a></li>
|
||
<li>[<strong>feature</strong>] button: allow for 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 the standard language for the <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 to stylesheet <a href="https://github.com/McShelby/hugo-theme-relearn/issues/286" target="_blank">#286</a></li>
|
||
<li>[<strong>feature</strong>] math: add mathjax rendering <a href="https://github.com/McShelby/hugo-theme-relearn/issues/235" target="_blank">#235</a></li>
|
||
<li>[<strong>feature</strong>] theme: allow for page heading modification <a href="https://github.com/McShelby/hugo-theme-relearn/issues/139" target="_blank">#139</a></li>
|
||
</ul>
|
||
<h3 id="fixes-47">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] favicon: fix URL if site resides in 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 for 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 visible on hover <a href="https://github.com/McShelby/hugo-theme-relearn/issues/297" target="_blank">#297</a></li>
|
||
<li>[<strong>bug</strong>] print: disable arrow navigation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/294" target="_blank">#294</a></li>
|
||
<li>[<strong>bug</strong>] print: add missing page break after 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 of chapter heading <a href="https://github.com/McShelby/hugo-theme-relearn/issues/289" target="_blank">#289</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-7">Maintenance</h3>
|
||
<ul>
|
||
<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 Mermaid 9.1.3 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/293" target="_blank">#293</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="425-2022-06-23">4.2.5 (2022-06-23)</h2>
|
||
<h3 id="fixes-48">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: javascript code does not load in documentation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/285" target="_blank">#285</a></li>
|
||
<li>[<strong>bug</strong>] children: descriptions not working <a href="https://github.com/McShelby/hugo-theme-relearn/issues/284" target="_blank">#284</a></li>
|
||
<li>[<strong>bug</strong>] print: fix empty page for shortcut links <a href="https://github.com/McShelby/hugo-theme-relearn/issues/283" target="_blank">#283</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="424-2022-06-23">4.2.4 (2022-06-23)</h2>
|
||
<h3 id="fixes-49">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix url for logo and home button <a href="https://github.com/McShelby/hugo-theme-relearn/issues/282" target="_blank">#282</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="423-2022-06-23">4.2.3 (2022-06-23)</h2>
|
||
<h3 id="fixes-50">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>breaking</strong>] include: second parameter is ignored <a href="https://github.com/McShelby/hugo-theme-relearn/issues/281" target="_blank">#281</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="422-2022-06-23">4.2.2 (2022-06-23)</h2>
|
||
<p><em>No changelog for this release.</em></p>
|
||
<hr>
|
||
<h2 id="421-2022-06-23">4.2.1 (2022-06-23)</h2>
|
||
<p><em>No changelog for this release.</em></p>
|
||
<hr>
|
||
<h2 id="420-2022-06-23">4.2.0 (2022-06-23)</h2>
|
||
<h3 id="enhancements-22">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] tabs: don’t change tab selection 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>] shortcodes: convert to partials <a href="https://github.com/McShelby/hugo-theme-relearn/issues/277" target="_blank">#277</a></li>
|
||
</ul>
|
||
<h3 id="fixes-51">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: avoid builtin syntax-highlightning <a href="https://github.com/McShelby/hugo-theme-relearn/issues/280" target="_blank">#280</a></li>
|
||
<li>[<strong>bug</strong>] search: fix console message for missing lunr translations <a href="https://github.com/McShelby/hugo-theme-relearn/issues/278" target="_blank">#278</a></li>
|
||
<li>[<strong>bug</strong>] tabs: fix wrapping when having many tabs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/272" target="_blank">#272</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="411-2022-06-18">4.1.1 (2022-06-18)</h2>
|
||
<h3 id="fixes-52">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] notice: fix layout when content starts with heading <a href="https://github.com/McShelby/hugo-theme-relearn/issues/275" target="_blank">#275</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="410-2022-06-12">4.1.0 (2022-06-12)</h2>
|
||
<h3 id="enhancements-23">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: support multilang content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/271" target="_blank">#271</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="405-2022-06-12">4.0.5 (2022-06-12)</h2>
|
||
<h3 id="fixes-53">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] i18n: Vietnamese language with 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 for non western languages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/269" target="_blank">#269</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="404-2022-06-07">4.0.4 (2022-06-07)</h2>
|
||
<h3 id="enhancements-24">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: improve keyboard navigation for scrolling <a href="https://github.com/McShelby/hugo-theme-relearn/issues/268" target="_blank">#268</a></li>
|
||
</ul>
|
||
<h3 id="fixes-54">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] swagger: adjust font-size for 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 compatible with Hugo 0.100.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/263" target="_blank">#263</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-8">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] swagger: update rapidoc to 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 to 9.1.1 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/265" target="_blank">#265</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="403-2022-06-05">4.0.3 (2022-06-05)</h2>
|
||
<h3 id="enhancements-25">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] toc: add scrollbar <a href="https://github.com/McShelby/hugo-theme-relearn/issues/262" target="_blank">#262</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="402-2022-06-05">4.0.2 (2022-06-05)</h2>
|
||
<h3 id="fixes-55">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: let browser scroll page on CTRL+f <a href="https://github.com/McShelby/hugo-theme-relearn/issues/242" target="_blank">#242</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="401-2022-06-05">4.0.1 (2022-06-05)</h2>
|
||
<p><em>No changelog for this release.</em></p>
|
||
<hr>
|
||
<h2 id="400-2022-06-05">4.0.0 (2022-06-05)</h2>
|
||
<h3 id="enhancements-26">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] shortcodes: add named parameter if missing <a href="https://github.com/McShelby/hugo-theme-relearn/issues/260" target="_blank">#260</a></li>
|
||
<li>[<strong>feature</strong>][<strong>breaking</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 translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/254" target="_blank">#254</a></li>
|
||
<li>[<strong>feature</strong>] attachments: support for brand colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/252" target="_blank">#252</a></li>
|
||
<li>[<strong>feature</strong>] notice: support for brand colors <a href="https://github.com/McShelby/hugo-theme-relearn/issues/251" target="_blank">#251</a></li>
|
||
<li>[<strong>feature</strong>][<strong>breaking</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 for 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 for 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 translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/237" target="_blank">#237</a></li>
|
||
</ul>
|
||
<h3 id="fixes-56">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] shortcodes: accept boolean parameters if given as string <a href="https://github.com/McShelby/hugo-theme-relearn/issues/261" target="_blank">#261</a></li>
|
||
<li>[<strong>bug</strong>] print: adjust button and tab size <a href="https://github.com/McShelby/hugo-theme-relearn/issues/259" target="_blank">#259</a></li>
|
||
<li>[<strong>bug</strong>] print: show Mermaid if requested in 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 of tooltip for heading anchor <a href="https://github.com/McShelby/hugo-theme-relearn/issues/241" target="_blank">#241</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="341-2022-04-03">3.4.1 (2022-04-03)</h2>
|
||
<h3 id="fixes-57">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix IE11 incompatibilities <a href="https://github.com/McShelby/hugo-theme-relearn/issues/234" target="_blank">#234</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="340-2022-04-03">3.4.0 (2022-04-03)</h2>
|
||
<h3 id="enhancements-27">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Traditional Chinese translation <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 navigation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/231" target="_blank">#231</a></li>
|
||
<li>[<strong>feature</strong>] print: add option to print whole chapter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/230" target="_blank">#230</a></li>
|
||
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: apply user supplied content footer below content <a href="https://github.com/McShelby/hugo-theme-relearn/issues/229" target="_blank">#229</a></li>
|
||
</ul>
|
||
<h3 id="fixes-58">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: scroll to heading on initial load <a href="https://github.com/McShelby/hugo-theme-relearn/issues/232" target="_blank">#232</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="330-2022-03-28">3.3.0 (2022-03-28)</h2>
|
||
<h3 id="enhancements-28">Enhancements</h3>
|
||
<ul>
|
||
<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 for oas/swagger documentation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/226" target="_blank">#226</a></li>
|
||
</ul>
|
||
<h3 id="fixes-59">Fixes</h3>
|
||
<ul>
|
||
<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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="321-2022-03-25">3.2.1 (2022-03-25)</h2>
|
||
<h3 id="fixes-60">Fixes</h3>
|
||
<ul>
|
||
<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 the title page <a href="https://github.com/McShelby/hugo-theme-relearn/issues/224" target="_blank">#224</a></li>
|
||
<li>[<strong>bug</strong>] theme: align content scrollbar to the right on big screens <a href="https://github.com/McShelby/hugo-theme-relearn/issues/223" target="_blank">#223</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="320-2022-03-19">3.2.0 (2022-03-19)</h2>
|
||
<h3 id="enhancements-29">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] mermaid: support differing themes for color variant switch <a href="https://github.com/McShelby/hugo-theme-relearn/issues/219" target="_blank">#219</a></li>
|
||
<li>[<strong>feature</strong>] mermaid: load javascript on demand <a href="https://github.com/McShelby/hugo-theme-relearn/issues/218" target="_blank">#218</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-9">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update to 8.14.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/220" target="_blank">#220</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="311-2022-03-16">3.1.1 (2022-03-16)</h2>
|
||
<h3 id="enhancements-30">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] i18n: add Korean translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/217" target="_blank">#217</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="310-2022-03-15">3.1.0 (2022-03-15)</h2>
|
||
<h3 id="enhancements-31">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] notice: add icon 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>
|
||
</ul>
|
||
<h3 id="fixes-61">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: make storage of multiple 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 in Chrome <a href="https://github.com/McShelby/hugo-theme-relearn/issues/213" target="_blank">#213</a></li>
|
||
<li>[<strong>bug</strong>] mobile: improve behavior of sidebar menu <a href="https://github.com/McShelby/hugo-theme-relearn/issues/210" target="_blank">#210</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="304-2022-02-24">3.0.4 (2022-02-24)</h2>
|
||
<h3 id="enhancements-32">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: improve font loading <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 variable naming <a href="https://github.com/McShelby/hugo-theme-relearn/issues/200" target="_blank">#200</a></li>
|
||
</ul>
|
||
<h3 id="fixes-62">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] variant: fix occasional fail when resetting 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 in IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/207" target="_blank">#207</a></li>
|
||
<li>[<strong>bug</strong>] variant: avoid flash of menu header when non default variant is 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 closing tag order in chapters <a href="https://github.com/McShelby/hugo-theme-relearn/issues/205" target="_blank">#205</a></li>
|
||
<li>[<strong>bug</strong>] theme: adjust breadcrumb and title for empty home page titles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/202" target="_blank">#202</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="303-2022-02-23">3.0.3 (2022-02-23)</h2>
|
||
<h3 id="enhancements-33">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tags: show tag count in taxonomy list <a href="https://github.com/McShelby/hugo-theme-relearn/issues/195" target="_blank">#195</a></li>
|
||
</ul>
|
||
<h3 id="fixes-63">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: remove Hugo build warning if page is 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 to 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 and variant selector in IE11 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/194" target="_blank">#194</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="302-2022-02-23">3.0.2 (2022-02-23)</h2>
|
||
<h3 id="enhancements-34">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tags: sort by name <a href="https://github.com/McShelby/hugo-theme-relearn/issues/193" target="_blank">#193</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="301-2022-02-23">3.0.1 (2022-02-23)</h2>
|
||
<h3 id="enhancements-35">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] children: set containerstyle automatically according to style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/192" target="_blank">#192</a></li>
|
||
</ul>
|
||
<h3 id="fixes-64">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: revert fontawsome to version 5 for IE11 compat <a href="https://github.com/McShelby/hugo-theme-relearn/issues/191" target="_blank">#191</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="300-2022-02-22">3.0.0 (2022-02-22)</h2>
|
||
<h3 id="enhancements-36">Enhancements</h3>
|
||
<ul>
|
||
<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 the page has headings <a href="https://github.com/McShelby/hugo-theme-relearn/issues/182" target="_blank">#182</a></li>
|
||
<li>[<strong>feature</strong>][<strong>breaking</strong>] theme: change default colors to Relearn 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>breaking</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 for 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 syntax highlightning 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>
|
||
</ul>
|
||
<h3 id="fixes-65">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: remove additional X in filled out search box in 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 for icons on hover <a href="https://github.com/McShelby/hugo-theme-relearn/issues/176" target="_blank">#176</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="296-2022-02-07">2.9.6 (2022-02-07)</h2>
|
||
<h3 id="fixes-66">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: remove debug output <a href="https://github.com/McShelby/hugo-theme-relearn/issues/171" target="_blank">#171</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="295-2022-02-07">2.9.5 (2022-02-07)</h2>
|
||
<h3 id="fixes-67">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: let arrow navigation respect ordersectionsby configuration <a href="https://github.com/McShelby/hugo-theme-relearn/issues/170" target="_blank">#170</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="294-2022-02-06">2.9.4 (2022-02-06)</h2>
|
||
<h3 id="fixes-68">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] exampleSite: fix links in official documentation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/168" target="_blank">#168</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="293-2022-02-06">2.9.3 (2022-02-06)</h2>
|
||
<h3 id="fixes-69">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: invalid URL when the shortcut is an internal link <a href="https://github.com/McShelby/hugo-theme-relearn/issues/163" target="_blank">#163</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="292-2021-11-26">2.9.2 (2021-11-26)</h2>
|
||
<h3 id="enhancements-37">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] theme: add theme version info to head <a href="https://github.com/McShelby/hugo-theme-relearn/issues/158" target="_blank">#158</a></li>
|
||
</ul>
|
||
<h3 id="fixes-70">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix selection of *.ico files as favicons <a href="https://github.com/McShelby/hugo-theme-relearn/issues/160" target="_blank">#160</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="291-2021-11-22">2.9.1 (2021-11-22)</h2>
|
||
<h3 id="fixes-71">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] menu: fix significantly low performance for collecting of meta info <a href="https://github.com/McShelby/hugo-theme-relearn/issues/157" target="_blank">#157</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="290-2021-11-19">2.9.0 (2021-11-19)</h2>
|
||
<h3 id="fixes-72">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>breaking</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 to search field when scrolling <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 missing right border for 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 sibling pages reliably <a href="https://github.com/McShelby/hugo-theme-relearn/issues/152" target="_blank">#152</a></li>
|
||
<li>[<strong>bug</strong>] menu: bring active item in sight for large menus <a href="https://github.com/McShelby/hugo-theme-relearn/issues/149" target="_blank">#149</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="283-2021-11-09">2.8.3 (2021-11-09)</h2>
|
||
<h3 id="fixes-73">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: let zoom reset to 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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="282-2021-11-08">2.8.2 (2021-11-08)</h2>
|
||
<h3 id="fixes-74">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: always load javascript to avoid break if code fences are used <a href="https://github.com/McShelby/hugo-theme-relearn/issues/142" target="_blank">#142</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="281-2021-11-04">2.8.1 (2021-11-04)</h2>
|
||
<h3 id="fixes-75">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] search: don’t break JS in multilang setup if search is disabled <a href="https://github.com/McShelby/hugo-theme-relearn/issues/140" target="_blank">#140</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="280-2021-11-03">2.8.0 (2021-11-03)</h2>
|
||
<h3 id="enhancements-38">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] toc: make disableTOC globally available 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 load 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 configurable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/2" target="_blank">#2</a></li>
|
||
</ul>
|
||
<h3 id="fixes-76">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: assert that window.mermaid is 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 of Hugos UniqueID <a href="https://github.com/McShelby/hugo-theme-relearn/issues/131" target="_blank">#131</a></li>
|
||
<li>[<strong>bug</strong>] theme: reduce margin for children shortcode <a href="https://github.com/McShelby/hugo-theme-relearn/issues/130" target="_blank">#130</a></li>
|
||
<li>[<strong>bug</strong>] theme: left-align h3 in 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 to clipboard <a href="https://github.com/McShelby/hugo-theme-relearn/issues/128" target="_blank">#128</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="270-2021-10-24">2.7.0 (2021-10-24)</h2>
|
||
<h3 id="enhancements-39">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] notice: support custom titles <a href="https://github.com/McShelby/hugo-theme-relearn/issues/124" target="_blank">#124</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="260-2021-10-21">2.6.0 (2021-10-21)</h2>
|
||
<h3 id="fixes-77">Fixes</h3>
|
||
<ul>
|
||
<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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="251-2021-10-12">2.5.1 (2021-10-12)</h2>
|
||
<h3 id="fixes-78">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] security: fix XSS for malicioius image URLs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/117" target="_blank">#117</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="250-2021-10-08">2.5.0 (2021-10-08)</h2>
|
||
<h3 id="enhancements-40">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>][<strong>change</strong>] syntax highlight: provide default colors for unknown languages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/113" target="_blank">#113</a></li>
|
||
</ul>
|
||
<h3 id="fixes-79">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] security: fix XSS for 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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="241-2021-10-07">2.4.1 (2021-10-07)</h2>
|
||
<h3 id="fixes-80">Fixes</h3>
|
||
<ul>
|
||
<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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="240-2021-10-07">2.4.0 (2021-10-07)</h2>
|
||
<h3 id="enhancements-41">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] lang: add vietnamese translation <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 for color variants <a href="https://github.com/McShelby/hugo-theme-relearn/issues/107" target="_blank">#107</a></li>
|
||
<li>[<strong>feature</strong>] hidden pages: 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 content in header <a href="https://github.com/McShelby/hugo-theme-relearn/issues/101" target="_blank">#101</a></li>
|
||
<li>[<strong>feature</strong>] menu: frontmatter option to 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 setting for 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>
|
||
</ul>
|
||
<h3 id="fixes-81">Fixes</h3>
|
||
<ul>
|
||
<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 is 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 to remove horizontal scrollbar <a href="https://github.com/McShelby/hugo-theme-relearn/issues/82" target="_blank">#82</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-10">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] chore: update fontawesome <a href="https://github.com/McShelby/hugo-theme-relearn/issues/94" target="_blank">#94</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="232-2021-09-20">2.3.2 (2021-09-20)</h2>
|
||
<h3 id="fixes-82">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] docs: rename history pirate translation <a href="https://github.com/McShelby/hugo-theme-relearn/issues/91" target="_blank">#91</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="231-2021-09-20">2.3.1 (2021-09-20)</h2>
|
||
<h3 id="fixes-83">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] docs: rename english pirate translation to avoid crash on rendering <a href="https://github.com/McShelby/hugo-theme-relearn/issues/90" target="_blank">#90</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="230-2021-09-13">2.3.0 (2021-09-13)</h2>
|
||
<h3 id="fixes-84">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix usage of section element <a href="https://github.com/McShelby/hugo-theme-relearn/issues/88" target="_blank">#88</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-11">Maintenance</h3>
|
||
<ul>
|
||
<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>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="220-2021-09-09">2.2.0 (2021-09-09)</h2>
|
||
<h3 id="enhancements-42">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] sitemap: hide hidden pages from sitemap and SEO indexing <a href="https://github.com/McShelby/hugo-theme-relearn/issues/85" target="_blank">#85</a></li>
|
||
</ul>
|
||
<h3 id="fixes-85">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] theme: fix showVisitedLinks in case Hugo is configured to modify relative URLs <a href="https://github.com/McShelby/hugo-theme-relearn/issues/86" target="_blank">#86</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-12">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] theme: switch from data-vocabulary to schema <a href="https://github.com/McShelby/hugo-theme-relearn/issues/84" target="_blank">#84</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="210-2021-09-07">2.1.0 (2021-09-07)</h2>
|
||
<h3 id="enhancements-43">Enhancements</h3>
|
||
<ul>
|
||
<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: disable search in hidden pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/76" target="_blank">#76</a></li>
|
||
<li>[<strong>feature</strong>] search: improve readablility of 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>
|
||
</ul>
|
||
<h3 id="fixes-86">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] search: hide non-site content <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 pages <a href="https://github.com/McShelby/hugo-theme-relearn/issues/77" target="_blank">#77</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="200-2021-08-28">2.0.0 (2021-08-28)</h2>
|
||
<h3 id="enhancements-44">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] tabs: enhance styling <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 pages 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 pages 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 for 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 readable <a href="https://github.com/McShelby/hugo-theme-relearn/issues/55" target="_blank">#55</a></li>
|
||
<li>[<strong>feature</strong>] children: add parameter for container style <a href="https://github.com/McShelby/hugo-theme-relearn/issues/53" target="_blank">#53</a></li>
|
||
<li>[<strong>feature</strong>] theme: make content 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 with alwaysopen parameter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/49" target="_blank">#49</a></li>
|
||
<li>[<strong>feature</strong>] include: new shortcode to include other files <a href="https://github.com/McShelby/hugo-theme-relearn/issues/43" target="_blank">#43</a></li>
|
||
<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 to standard hugo highlighter <a href="https://github.com/McShelby/hugo-theme-relearn/issues/32" target="_blank">#32</a></li>
|
||
</ul>
|
||
<h3 id="fixes-87">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>][<strong>change</strong>] arrow-nav: default sorting 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 sorting 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 pages <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: missing –MENU-HOME-LINK-HOVER-color in documentation <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>
|
||
</ul>
|
||
<h3 id="maintenance-13">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] docs: include changelog in exampleSite <a href="https://github.com/McShelby/hugo-theme-relearn/issues/33" target="_blank">#33</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="120-2021-07-26">1.2.0 (2021-07-26)</h2>
|
||
<h3 id="enhancements-45">Enhancements</h3>
|
||
<ul>
|
||
<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 and 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 option to open on page load <a href="https://github.com/McShelby/hugo-theme-relearn/issues/25" target="_blank">#25</a></li>
|
||
<li>[<strong>feature</strong>] expand: rework styling <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 restyling of 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 to 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 icons for notice box type <a href="https://github.com/McShelby/hugo-theme-relearn/issues/17" target="_blank">#17</a></li>
|
||
</ul>
|
||
<h3 id="fixes-88">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] attachments: support i18n for 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 for 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 in one box <a href="https://github.com/McShelby/hugo-theme-relearn/issues/15" target="_blank">#15</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-14">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] dependency: upgrade jquery to 3.6.0 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/30" target="_blank">#30</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="111-2021-07-04">1.1.1 (2021-07-04)</h2>
|
||
<h3 id="maintenance-15">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] theme: prepare for new hugo theme registration <a href="https://github.com/McShelby/hugo-theme-relearn/issues/13" target="_blank">#13</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="110-2021-07-02">1.1.0 (2021-07-02)</h2>
|
||
<h3 id="enhancements-46">Enhancements</h3>
|
||
<ul>
|
||
<li>[<strong>feature</strong>] mermaid: expose options in config.toml <a href="https://github.com/McShelby/hugo-theme-relearn/issues/4" target="_blank">#4</a></li>
|
||
</ul>
|
||
<h3 id="fixes-89">Fixes</h3>
|
||
<ul>
|
||
<li>[<strong>bug</strong>] mermaid: config option for 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 in 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 for 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 load may bomb chart <a href="https://github.com/McShelby/hugo-theme-relearn/issues/5" target="_blank">#5</a></li>
|
||
</ul>
|
||
<h3 id="maintenance-16">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] mermaid: update to 8.10.2 <a href="https://github.com/McShelby/hugo-theme-relearn/issues/7" target="_blank">#7</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="101-2021-07-01">1.0.1 (2021-07-01)</h2>
|
||
<h3 id="maintenance-17">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] Prepare for hugo showcase <a href="https://github.com/McShelby/hugo-theme-relearn/issues/3" target="_blank">#3</a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2 id="100-2021-07-01">1.0.0 (2021-07-01)</h2>
|
||
<h3 id="maintenance-18">Maintenance</h3>
|
||
<ul>
|
||
<li>[<strong>task</strong>] Fork project <a href="https://github.com/McShelby/hugo-theme-relearn/issues/1" target="_blank">#1</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
<article class="chapter">
|
||
<div class="article-subheading">Chapter 2</div>
|
||
<h1 id="content">Content</h1>
|
||
|
||
<p>Find out how to create and organize your content quickly and intuitively.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Content</h1>
|
||
<article class="default">
|
||
<h1 id="pages-organization">Pages organization</h1>
|
||
|
||
<p>In <strong>Hugo</strong>, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.</p>
|
||
<h2 id="folders">Folders</h2>
|
||
<p>Organize your site like <a href="https://gohugo.io/content/organization/" target="_blank">any other Hugo project</a>. Typically, you will have a <em>content</em> folder with all your pages.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">content
|
||
</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>
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p><code>_index.md</code> is required in each folder, it’s your “folder home page”</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="create-your-project">Create your project</h2>
|
||
<p>The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you to train by following <a href="https://gohugo.io/overview/quickstart/" target="_blank">great documentation for beginners</a>.</p>
|
||
<p>Hugo provides a <code>new</code> command to 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 site <new_project>
|
||
</span></span></code></pre></div><p>The Relearn theme provides <a href="./cont/archetypes/">archetypes</a> to help you create this kind of pages.</p>
|
||
<h2 id="frontmatter-configuration">Frontmatter Configuration</h2>
|
||
<p>Each Hugo page has to define a <a href="https://gohugo.io/content/front-matter/" target="_blank">frontmatter</a> in <em>toml</em>, <em>yaml</em> or <em>json</em>. This site will use <em>toml</em> in all cases.</p>
|
||
<p>The Relearn theme uses the following parameters on top of Hugo ones:</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="c"># Table of contents (toc) is enabled by default. Set this parameter to true to disable it.</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Note: Toc is always disabled for chapter pages</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 for the page's menu entry (instead of the `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 for the expand state of 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 for the sorting order of 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>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The title of the page heading will be prefixed by this HTML content</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"># The title of the page heading will be postfixed by this HTML content</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">headingPost</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The title of the page in menu will be prefixed by this HTML content</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuPre</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># The title of the page in menu will be postfixed by this HTML content</span>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">menuPost</span> <span class="p">=</span> <span class="s2">""</span>
|
||
</span></span><span class="line"><span class="cl"><span class="c"># Hide a menu entry by setting this to 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 of this page modifier. If set, it will be displayed in the 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 of this page modifier. If set with LastModifierDisplayName, it will be displayed in the 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 icon to a menu entry</h3>
|
||
<p>In the page frontmatter, add a <code>menuPre</code> param to insert any HTML code before the menu label. The example below uses the GitHub icon.</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">"GitHub repo"</span>
|
||
</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>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span></code></pre></div><p>
|
||
|
||
<a href="#image-facf1e8dfd693d15aedf981c9143a5a7" class="lightbox-link">
|
||
<img src="./cont/pages/frontmatter-icon.png?classes=shadow&width=18.75rem" alt="Title with icon" class="shadow" style="height: auto; width: 18.75rem;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-facf1e8dfd693d15aedf981c9143a5a7">
|
||
<img src="./cont/pages/frontmatter-icon.png?classes=shadow&width=18.75rem" alt="Title with icon" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
<h3 id="ordering-sibling-menupage-entries">Ordering sibling menu/page entries</h3>
|
||
<p>Hugo provides a <a href="https://gohugo.io/content/ordering/" target="_blank">flexible way</a> to handle order for your pages.</p>
|
||
<p>The simplest way is to set <code>weight</code> parameter to 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">Using a custom title for menu entries</h3>
|
||
<p>By default, the Relearn theme will use a page’s <code>title</code> attribute for the menu item (or <code>linkTitle</code> if defined).</p>
|
||
<p>But a page’s title has to be descriptive on its own while the menu is a hierarchy.
|
||
We’ve added the <code>menuTitle</code> parameter for that purpose:</p>
|
||
<p>For example (for a page 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 for menu entries</h3>
|
||
<p>You can change how the theme expands menu entries on the side of the content with the <code>alwaysopen</code> setting on a per page basis. If <code>alwaysopen=false</code> for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.</p>
|
||
<p>The theme generates the menu based on the following rules:</p>
|
||
<ul>
|
||
<li>all parent entries of the active page including their siblings are shown regardless of any settings</li>
|
||
<li>immediate children entries of the active page are shown regardless of any settings</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 of levels besides the first behave like they would have been given <code>alwaysopen=true</code></li>
|
||
<li>all visible entries show their immediate children entries if <code>alwaysopen=true</code>; this proceeds recursively</li>
|
||
<li>all remaining entries are not shown</li>
|
||
</ul>
|
||
<p>You can see this feature in action on the example page for <a href="./shortcodes/children/">children shortcode</a> and its children pages.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="archetypes">Archetypes</h1>
|
||
|
||
<p>Using the command: <code>hugo new [relative new content path]</code>, you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: <a href="https://gohugo.io/content/archetypes/" target="_blank">archetypes</a>. These are preconfigured skeleton pages with default frontmatter.</p>
|
||
<p>The Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.</p>
|
||
<h2 id="predefined-archetypes">Predefined Archetypes</h2>
|
||
<h3 id="archetypes-home">Home</h3>
|
||
<p>A <strong>Home</strong> page is the starting page of your project. It’s best to have only one page of this kind in your project.</p>
|
||
<p>
|
||
|
||
<a href="#image-f5a4f45438494d98d531a2b8c89224c0" class="lightbox-link">
|
||
<img src="./cont/archetypes/pages-home.png?classes=shadow&width=60pc" alt="Home page" class="shadow" style="height: auto; width: 60pc;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-f5a4f45438494d98d531a2b8c89224c0">
|
||
<img src="./cont/archetypes/pages-home.png?classes=shadow&width=60pc" alt="Home page" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
<p>To create a home page, run the following 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 to a file with the following content</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">+++
|
||
</span></span><span class="line"><span class="cl">
|
||
</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 page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found below it.</p>
|
||
<p>
|
||
|
||
<a href="#image-37c229a5bc54639b81c5d81b2e80a3ee" class="lightbox-link">
|
||
<img src="./cont/archetypes/pages-chapter.png?classes=shadow&width=60pc" alt="Chapter page" class="shadow" style="height: auto; width: 60pc;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-37c229a5bc54639b81c5d81b2e80a3ee">
|
||
<img src="./cont/archetypes/pages-chapter.png?classes=shadow&width=60pc" alt="Chapter page" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
<p>To create a chapter page, run the following 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 to a file with the following content</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">+++
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Lorem Ipsum.
|
||
</span></span></code></pre></div><p>Replace the <code>X</code> with a number. Because this number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.</p>
|
||
<h3 id="archetypes-default">Default</h3>
|
||
<p>A <strong>Default</strong> page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.</p>
|
||
<p>
|
||
|
||
<a href="#image-e2df5d7b54d71cf8ab7dd31bdffaf846" class="lightbox-link">
|
||
<img src="./cont/archetypes/pages-default.png?classes=shadow&width=60pc" alt="Default page" class="shadow" style="height: auto; width: 60pc;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-e2df5d7b54d71cf8ab7dd31bdffaf846">
|
||
<img src="./cont/archetypes/pages-default.png?classes=shadow&width=60pc" alt="Default page" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
<p>To create a default page, run either one of the following commands</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>/_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
|
||
</span></span></code></pre></div><p>This leads to a file with the following content</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">+++
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Lorem Ipsum.
|
||
</span></span></code></pre></div><p>Replace the <code>X</code> with a number or delete the whole <code>weight</code> parameter entirely.</p>
|
||
<h2 id="self-defined-archetypes">Self defined Archetypes</h2>
|
||
<p>If you are in need of further archetypes you can define your own or even redefine existing ones.</p>
|
||
<h3 id="template">Template</h3>
|
||
<p>Define a template file in your project at <code>archetypes/<kind>.md</code> and make sure it has at least the frontmatter parameter for 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">+++
|
||
</span></span></code></pre></div><p>Afterwards you can generate new content files of that kind with the following 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 <kind> <name>/_index.md
|
||
</span></span></code></pre></div><h3 id="partials">Partials</h3>
|
||
<p>To define how your archetypes are rendered, define corresponding partial files in your projects directory <code>layouts/partials/archetypes/<kind></code>.</p>
|
||
<p>If you use an unknown archetype in your frontmatter, the <code>default</code> archetype will be used to generate the page.</p>
|
||
<p>Related to each archetype, several <em>hook</em> partial files in the form of <code><hook>.html</code> can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.</p>
|
||
<p>The following hooks are 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 of CSS classes to be added to the HTML’s <code><main></code> element. You can use these classes to define own CSS rules in your <code>custom-header.html</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left">article</td>
|
||
<td style="text-align:left">Defines the HTML how to render your content</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Take a look at the existing archetypes of this theme to get an idea how to utilize it.</p>
|
||
<h4 id="output-formats">Output formats</h4>
|
||
<p>Each hook file can be overridden of a specific <a href="https://gohugo.io/templates/output-formats/" target="_blank">output format</a>. Eg. if you define a new output format <code>PLAINTEXT</code> in your <code>config.toml</code>, you can add a file <code>layouts/partials/archetypes/default.plaintext.html</code> to change the way how normal content is written for that output format.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="markdown-syntax">Markdown syntax</h1>
|
||
|
||
<p>Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.</p>
|
||
<p><strong>Markdown</strong> is a better way to write <strong>HTML</strong>, without all the complexities and ugliness that usually accompanies it.</p>
|
||
<p>Some of the key benefits are:</p>
|
||
<ol>
|
||
<li>Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content.</li>
|
||
<li>Less chance of errors when writing in Markdown.</li>
|
||
<li>Produces valid HTML output.</li>
|
||
<li>Keeps the content and the visual display separate, so you cannot mess up the look of your site.</li>
|
||
<li>Write in any text editor or Markdown application you like.</li>
|
||
<li>Markdown is a joy to use!</li>
|
||
</ol>
|
||
<p>John Gruber, the author of Markdown, puts it like this:</p>
|
||
<blockquote>
|
||
<p>The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
|
||
<cite>John Gruber</cite></p>
|
||
</blockquote>
|
||
<p>Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:</p>
|
||
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
<p><i class="fa-fw fas fa-bookmark"></i> Bookmark this page and the <a href="https://commonmark.org/help/" target="_blank">official Commonmark reference</a> for easy future reference!</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="paragraphs">Paragraphs</h2>
|
||
<p>In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.</p>
|
||
<p>Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to 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>
|
||
</div>
|
||
</div>
|
||
<h2 id="headings">Headings</h2>
|
||
<p>A good idea is to structure your content using headings and subheadings. HTML-headings from <code>h1</code> through <code>h6</code> are constructed with a <code>#</code> for each level.</p>
|
||
<p>In Hugo you usually don’t use <code>h1</code> as this is generated by your theme and you should only have one such element in a document.</p>
|
||
<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 Heading
|
||
</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 Heading
|
||
</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 Heading
|
||
</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 Heading
|
||
</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 Heading
|
||
</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 Heading
|
||
</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">
|
||
<h1 id="h1-heading">h1 Heading</h1>
|
||
<h2 id="h2-heading">h2 Heading</h2>
|
||
<h3 id="h3-heading">h3 Heading</h3>
|
||
<h4 id="h4-heading">h4 Heading</h4>
|
||
<h5 id="h5-heading">h5 Heading</h5>
|
||
<h6 id="h6-heading">h6 Heading</h6>
|
||
</div>
|
||
</div>
|
||
<h2 id="horizontal-rules">Horizontal Rules</h2>
|
||
<p>To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with 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>
|
||
<hr>
|
||
<p>Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="text-markers">Text Markers</h2>
|
||
<h3 id="bold">Bold</h3>
|
||
<p>You can show importance of a snippet of text with a heavier font-weight by enclosing it with 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 with <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 with <strong>bold text</strong></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="italics">Italics</h3>
|
||
<p>You can emphasize a snippet of text with italics by enclosing it with 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 with <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 with <em>italicized text</em></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="strikethrough">Strikethrough</h3>
|
||
<p>In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes <code>~~</code>.</p>
|
||
<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>
|
||
</div>
|
||
</div>
|
||
<h2 id="text-substitution">Text substitution</h2>
|
||
<p>This Markdown dialect supports an extension to combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of 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">Double quotes <span class="sb">`"`</span> and single quotes <span class="sb">`'`</span> of enclosed text are replaced by <span class="ge">**</span>"double curly quotes"** and <span class="ge">**</span>'single curly quotes'**.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Double dashes <span class="sb">`--`</span> and triple dashes <span class="sb">`---`</span> are replaced by en-dash <span class="ge">**</span>--** and em-dash <span class="ge">**</span>---** entities.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Double arrows pointing left <span class="sb">`<<`</span> or right <span class="sb">`>>`</span> are replaced by arrow <span class="ge">**</span><span class="err"><<</span>** and <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> are 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>Double quotes <code>"</code> and single quotes <code>'</code> of enclosed text are replaced by <strong>“double curly quotes”</strong> and <strong>‘single curly quotes’</strong>.</p>
|
||
<p>Double dashes <code>--</code> and triple dashes <code>---</code> are replaced by en-dash <strong>–</strong> and em-dash <strong>—</strong> entities.</p>
|
||
<p>Double arrows pointing left <code><<</code> or right <code>>></code> are replaced by arrow <strong>«</strong> and <strong>»</strong> entities.</p>
|
||
<p>Three consecutive dots <code>...</code> are replaced by an ellipsis <strong>…</strong> entity.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="lists">Lists</h2>
|
||
<h3 id="unordered">Unordered</h3>
|
||
<p>You can write a list of items in which the order of the items does not explicitly matter.</p>
|
||
<p>It is possible to nest lists by indenting an item for the next sublevel.</p>
|
||
<p>You may use any of <code>-</code>, <code>*</code> or <code>+</code> to denote bullets for 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 adipiscing elit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Vestibulum laoreet porttitor sem
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Ac tristique libero volutpat at
|
||
</span></span><span class="line"><span class="cl"><span class="k">-</span> Nulla volutpat aliquam velit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Phasellus iaculis neque
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Purus sodales ultricies
|
||
</span></span><span class="line"><span class="cl"><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">
|
||
<ul>
|
||
<li>Lorem ipsum dolor sit amet</li>
|
||
<li>Consectetur adipiscing elit
|
||
<ul>
|
||
<li>Vestibulum laoreet porttitor sem</li>
|
||
<li>Ac tristique libero volutpat at</li>
|
||
</ul>
|
||
</li>
|
||
<li>Nulla volutpat aliquam velit
|
||
<ul>
|
||
<li>Phasellus iaculis neque</li>
|
||
<li>Purus sodales ultricies</li>
|
||
</ul>
|
||
</li>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<h3 id="ordered">Ordered</h3>
|
||
<p>You can create a list of items in which the order of items does explicitly matter.</p>
|
||
<p>It is possible to nest lists by indenting an item for the next sublevel.</p>
|
||
<p>Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.</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">1.</span> Lorem ipsum dolor sit amet
|
||
</span></span><span class="line"><span class="cl"><span class="k">3.</span> Consectetur adipiscing 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 in 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">
|
||
<ol>
|
||
<li>Lorem ipsum dolor sit amet</li>
|
||
<li>Consectetur adipiscing elit
|
||
<ol>
|
||
<li>Integer molestie lorem at massa</li>
|
||
<li>Facilisis in pretium nisl aliquet</li>
|
||
</ol>
|
||
</li>
|
||
<li>Nulla volutpat aliquam velit
|
||
<ol>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
<li>Aenean sit amet erat nunc</li>
|
||
</ol>
|
||
</li>
|
||
<li>Eget porttitor lorem</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
<h3 id="tasks">Tasks</h3>
|
||
<p>In GFM (GitHub Flavored Markdown) you can add task lists resulting in checked or unchecked non-clickable items</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">- [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
|
||
</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">
|
||
<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>
|
||
</div>
|
||
</div>
|
||
<h3 id="definitions">Definitions</h3>
|
||
<p>This Markdown dialect supports an extension to add definition lists. Definition lists are made of terms and definitions of these terms, much like in a dictionary.</p>
|
||
<p>A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.</p>
|
||
<p>If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible</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 of plants of the genus Malus in the 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">: The fruit of an evergreen tree of the genus Citrus.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> You can make juice out of it.
|
||
</span></span><span class="line"><span class="cl">: A telecommunication company.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> You can't make juice out of 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 of plants of the genus Malus in the family Rosaceae.</dd>
|
||
<dd>An American computer company.</dd>
|
||
<dt>Orange</dt>
|
||
<dd>The fruit of an evergreen tree of the genus Citrus.
|
||
<p>You can make juice out of it.</p>
|
||
</dd>
|
||
<dd>A telecommunication company.
|
||
<p>You can’t make juice out of it.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</div>
|
||
<h2 id="code">Code</h2>
|
||
<h3 id="inline-code">Inline Code</h3>
|
||
<p>Inline snippets of code can be wrapped with 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> is 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> is marked as code.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="indented-code-block">Indented Code Block</h3>
|
||
<p>A simple code block can be generated by indenting several lines of 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
|
||
</span></span><span class="line"><span class="cl"> line 1 of code
|
||
</span></span><span class="line"><span class="cl"> line 2 of code
|
||
</span></span><span class="line"><span class="cl"> line 3 of 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>Be impressed by my advanced code:</p>
|
||
<pre><code>// Some comments
|
||
line 1 of code
|
||
line 2 of code
|
||
line 3 of code
|
||
</code></pre>
|
||
</div>
|
||
</div>
|
||
<h3 id="fenced-code-block">Fenced Code Block</h3>
|
||
<p>If you want to gain more control of your code block you can enclose your code by at least three backticks <code>```</code> a so called fence.</p>
|
||
<p>In GFM (GitHub Flavored Markdown) you can also add a language specifier directly after the opening fence, <code>```js</code>, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.</p>
|
||
<p>See <a href="./cont/syntaxhighlight/">Code Highlighting</a> for additional documentation.</p>
|
||
<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"> options: {
|
||
</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"> pages: {
|
||
</span></span><span class="line"><span class="cl"> options: {
|
||
</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">```
|
||
</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">
|
||
<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">options</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">pages</span><span class="o">:</span> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">options</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>
|
||
</span></span></code></pre></div> </div>
|
||
</div>
|
||
<h2 id="tables">Tables</h2>
|
||
<p>In GFM (GitHub Flavored Markdown) you can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">| Option | Description |
|
||
</span></span><span class="line"><span class="cl">| ------ | ----------- |
|
||
</span></span><span class="line"><span class="cl">| data | path to data files to supply the data that will be passed into templates. |
|
||
</span></span><span class="line"><span class="cl">| engine | engine to be used for processing templates. Handlebars is the default. |
|
||
</span></span><span class="line"><span class="cl">| ext | extension to be used for 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>
|
||
<thead>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>data</td>
|
||
<td>path to data files to supply the data that will be passed into templates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>engine</td>
|
||
<td>engine to be used for processing templates. Handlebars is the default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ext</td>
|
||
<td>extension to be used for dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<h3 id="aligned-columns">Aligned Columns</h3>
|
||
<p>Adding a colon on the left and/or right side of the dashes below any heading will align the text for 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">| Option | Number | Description |
|
||
</span></span><span class="line"><span class="cl">| ------:|:------:|:----------- |
|
||
</span></span><span class="line"><span class="cl">| data | 1 | path to data files to supply the data that will be passed into templates. |
|
||
</span></span><span class="line"><span class="cl">| engine | 2 | engine to be used for processing templates. Handlebars is the default. |
|
||
</span></span><span class="line"><span class="cl">| ext | 3 | extension to be used for 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>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:right">Option</th>
|
||
<th style="text-align:center">Number</th>
|
||
<th style="text-align:left">Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:right">data</td>
|
||
<td style="text-align:center">1</td>
|
||
<td style="text-align:left">path to data files to supply the data that will be passed into templates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:right">engine</td>
|
||
<td style="text-align:center">2</td>
|
||
<td style="text-align:left">engine to be used for processing templates. Handlebars is the default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:right">ext</td>
|
||
<td style="text-align:center">3</td>
|
||
<td style="text-align:left">extension to be used for dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<h2 id="blockquotes">Blockquotes</h2>
|
||
<p>For quoting blocks of content from another source within your document add <code>></code> before any text you want to 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 in, 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 adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in 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 in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.</p>
|
||
<blockquote>
|
||
<p>Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in 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>
|
||
</div>
|
||
</div>
|
||
<h2 id="links">Links</h2>
|
||
<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 is a link to 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">
|
||
<p>This is a link to <a href="https://example.com" target="_blank">https://example.com</a>.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="basic-link">Basic Link</h3>
|
||
<p>You can explicitly define links in case you want to use non-absolute URLs or want to give different text.</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">Assemble</span>](<span class="na">http://assemble.io</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><a href="http://assemble.io" target="_blank">Assemble</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="link-with-tooltip">Link with Tooltip</h3>
|
||
<p>For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.</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">Upstage</span>](<span class="na">https://github.com/upstage/ "Visit Upstage!"</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><a href="https://github.com/upstage/" title="Visit Upstage!" target="_blank">Upstage</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="link-references">Link References</h3>
|
||
<p>Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in 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 to 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">
|
||
<p><a href="https://example.com" title="Go to example domain" target="_blank">Example</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="footnotes">Footnotes</h3>
|
||
<p>Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.</p>
|
||
<p>Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.</p>
|
||
<p>Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.</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 with a footnote[^1]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[^1]: And that's the footnote.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">That's some more text with a footnote.[^someid]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[^someid]:
|
||
</span></span><span class="line"><span class="cl"> Anything of interest goes here.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> Blue light glows blue.
|
||
</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>That’s some text with 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 with 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>And that’s the footnote. <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
<li id="fn:2">
|
||
<p>Anything of interest goes here.</p>
|
||
<p>Blue light glows blue. <a href="#fnref:2" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="images">Images</h2>
|
||
<h3 id="basic-images">Basic Images</h3>
|
||
<p>Images have a similar syntax to links but include a preceding exclamation mark.</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">Spock</span>](<span class="na">https://octodex.github.com/images/spocktocat.png</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>
|
||
|
||
<a href="#image-8bb406e001587da642eb6e5195055fb2" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-8bb406e001587da642eb6e5195055fb2">
|
||
<img src="https://octodex.github.com/images/spocktocat.png?width=20vw&classes=bg-white" alt="Spock" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="image-with-tooltip">Image with Tooltip</h3>
|
||
<p>Like links, images can also be given a tooltip.</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">Picard</span>](<span class="na">https://octodex.github.com/images/jean-luc-picat.jpg "Jean Luc Picard"</span>)
|
||
</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
<p>
|
||
|
||
<a href="#image-bf725949f1989ba929772b16e5a19900" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-bf725949f1989ba929772b16e5a19900">
|
||
<img src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt="Picard" title="Jean Luc Picard" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="image-references">Image References</h3>
|
||
<p>Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.</p>
|
||
<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"
|
||
</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>
|
||
|
||
<a href="#image-4af9f704de047c194efaf532ce2df5b2" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-4af9f704de047c194efaf532ce2df5b2">
|
||
<img src="https://octodex.github.com/images/trekkie.jpg?width=20vw" alt="La Forge" title="Geordi La Forge" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="further-image-formatting">Further Image Formatting</h3>
|
||
<p>This theme allows additional non-standard formatting by setting query parameter at the end of the image URL.</p>
|
||
<h4 id="resizing">Resizing</h4>
|
||
<p>Add query parameter <code>width</code> and/or <code>height</code> to the link image to resize the image. Values are CSS values (default is <code>auto</code>).</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">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?width=20vw</span>)
|
||
</span></span></code></pre></div>
|
||
<div class="box notices cstyle secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
<p>
|
||
|
||
<a href="#image-960a7880b2414a2a3e360754ec46ac07" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-960a7880b2414a2a3e360754ec46ac07">
|
||
<img src="https://octodex.github.com/images/minion.png?width=20vw&classes=bg-white" alt="Minion" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<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>)
|
||
</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>
|
||
|
||
<a href="#image-c25951b661b59d5be03034e5b8ac42d5" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-c25951b661b59d5be03034e5b8ac42d5">
|
||
<img src="https://octodex.github.com/images/minion.png?height=50px&classes=bg-white" alt="Minion" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<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>)
|
||
</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>
|
||
|
||
|
||
<a href="#image-820562b595b991085aca61c9599dd85c" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-820562b595b991085aca61c9599dd85c">
|
||
<img src="https://octodex.github.com/images/minion.png?height=50px&width=40vw&classes=bg-white" alt="Minion" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h4 id="css-classes">CSS Classes</h4>
|
||
<p>Add a query parameter <code>classes</code> to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.</p>
|
||
<h5 id="shadow">Shadow</h5>
|
||
<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>)
|
||
</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>
|
||
|
||
<a href="#image-4ae053b6c3d516c2cec4d1cafe8c4140" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-4ae053b6c3d516c2cec4d1cafe8c4140">
|
||
<img src="https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,bg-white" alt="Spidertocat" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="border">Border</h5>
|
||
<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>)
|
||
</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>
|
||
|
||
<a href="#image-5aeebb067b9858e09aded5576c19e955" class="lightbox-link">
|
||
<img src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border" alt="DrOctocat" class="border" style="height: auto; width: 20vw;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-5aeebb067b9858e09aded5576c19e955">
|
||
<img src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border" alt="DrOctocat" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="left">Left</h5>
|
||
<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>)
|
||
</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>
|
||
|
||
<a href="#image-9e0d3837f94860d6ea1fd9a3cec0bb6f" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-9e0d3837f94860d6ea1fd9a3cec0bb6f">
|
||
<img src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt="Supertocat" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="right">Right</h5>
|
||
<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>)
|
||
</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>
|
||
|
||
<a href="#image-ba82e9d7da444e98b737f8364782657d" class="lightbox-link">
|
||
<img src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt="Riddlocat" class="right" style="height: auto; width: 20vw;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-ba82e9d7da444e98b737f8364782657d">
|
||
<img src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt="Riddlocat" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="inline">Inline</h5>
|
||
<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>)
|
||
</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>
|
||
|
||
<a href="#image-1e29a2f03bee830ac5552b5b3f180390" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-1e29a2f03bee830ac5552b5b3f180390">
|
||
<img src="https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline,bg-white" alt="Spidertocat" class="lightbox-image" loading="lazy">
|
||
</a>
|
||
|
||
|
||
<a href="#image-17e41c3b019ab2cc566940bf6319c5ef" class="lightbox-link">
|
||
<img src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt="DrOctocat" class="inline" style="height: auto; width: 10vw;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-17e41c3b019ab2cc566940bf6319c5ef">
|
||
<img src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt="DrOctocat" class="lightbox-image" loading="lazy">
|
||
</a>
|
||
|
||
|
||
<a href="#image-783cae76b891199365315ad8e530fdfe" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-783cae76b891199365315ad8e530fdfe">
|
||
<img src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt="Supertocat" class="lightbox-image" loading="lazy">
|
||
</a>
|
||
|
||
|
||
<a href="#image-34461e5ff732a5db5135f88e1dcb14cd" class="lightbox-link">
|
||
<img src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt="Riddlocat" class="inline" style="height: auto; width: 10vw;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-34461e5ff732a5db5135f88e1dcb14cd">
|
||
<img src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt="Riddlocat" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h5 id="combination">Combination</h5>
|
||
<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>
|
||
|
||
<a href="#image-c11259cac7cb799e0e32203e14e0eed4" class="lightbox-link">
|
||
<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">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-c11259cac7cb799e0e32203e14e0eed4">
|
||
<img src="https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt="X-tocat" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
</div>
|
||
</div>
|
||
<h4 id="lightbox">Lightbox</h4>
|
||
<p>Add the query parameter <code>lightbox=false</code> to the image link to disable the 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>)
|
||
</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>
|
||
|
||
<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>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="code-highlighting">Code highlighting</h1>
|
||
|
||
<p>The Relearn theme uses <a href="https://gohugo.io/content-management/syntax-highlighting/" target="_blank">Hugo’s built-in syntax highlighting</a> for code.</p>
|
||
<h2 id="markdown-syntax">Markdown syntax</h2>
|
||
<p>Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided.</p>
|
||
<!-- markdownlint-disable MD046 -->
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```json
|
||
</span></span><span class="line"><span class="cl">[
|
||
</span></span><span class="line"><span class="cl"> {
|
||
</span></span><span class="line"><span class="cl"> "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-disable MD046 -->
|
||
<p>Renders to:</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">[</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">{</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nt">"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>
|
||
<p>Hugo comes with a <a href="https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages" target="_blank">remarkable list</a> of supported languages.</p>
|
||
<h2 id="recommended-configuration">Recommended configuration</h2>
|
||
<p>You can choose a color theme from the <a href="https://xyproto.github.io/splash/docs/all.html" target="_blank">list of supported themes</a> and add it in your <code>config.toml</code></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">markup</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">highlight</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># if `guessSyntax = true`, there will be no unstyled code even if no language</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># was given BUT Mermaid and Math codefences will not work anymore! So this is a</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># mandatory setting for your site if you want to use Mermaid or Math codefences</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">guessSyntax</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># choose a color theme or create your own</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">style</span> <span class="p">=</span> <span class="s2">"base16-snazzy"</span>
|
||
</span></span></code></pre></div>
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="menu-extra-shortcuts">Menu extra shortcuts</h1>
|
||
|
||
<p>You can define additional menu entries or shortcuts in the navigation menu without any link to content.</p>
|
||
<h2 id="basic-configuration">Basic configuration</h2>
|
||
<p>Edit the website configuration <code>config.toml</code> and add a <code>[[menu.shortcuts]]</code> entry for each link your want to add.</p>
|
||
<p>Example from the 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">"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> 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 are preceded by a title. This title can be disabled by setting <code>disableShortcutsTitle=true</code>.
|
||
However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.</p>
|
||
<p>For example, in your local <code>i18n/en.toml</code> file, add the following content</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>
|
||
</span></span></code></pre></div><p>Read more about <a href="https://gohugo.io/extras/menus/" target="_blank">hugo menu</a> and <a href="https://gohugo.io/content-management/multilingual/#translation-of-strings" target="_blank">hugo i18n translation strings</a></p>
|
||
<h2 id="i18n">Configuration for Multilingual mode</h2>
|
||
<p>When using a multilingual website, you can set different menus for each language. In the <code>config.toml</code> file, prefix your menu configuration by <code>Languages.<language-id></code>.</p>
|
||
<p>Example from the 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 Relearn 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="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">en</span><span class="p">.</span><span class="nx">params</span><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></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">"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> 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="p">[</span><span class="nx">languages</span><span class="p">.</span><span class="nx">pir</span><span class="p">.</span><span class="nx">params</span><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! 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">"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>
|
||
</span></span></code></pre></div><p>Read more about <a href="https://gohugo.io/extras/menus/" target="_blank">hugo menu</a> and <a href="https://gohugo.io/content-management/multilingual/#menus" target="_blank">hugo multilingual menus</a></p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="multilingual-and-i18n">Multilingual and i18n</h1>
|
||
|
||
<p>The Relearn theme is fully compatible with Hugo multilingual mode.</p>
|
||
<ul>
|
||
<li>Available 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 to contribute!</li>
|
||
<li>Full support for languages written right to left</li>
|
||
<li>Automatic menu generation from multilingual content</li>
|
||
<li>In-browser language switching</li>
|
||
</ul>
|
||
<p>
|
||
|
||
<a href="#image-c55db9f763db66ebd2ef56c533290fd8" class="lightbox-link">
|
||
<img src="./cont/i18n/i18n-menu.gif?classes=shadow&width=18.75rem" alt="I18n menu" class="shadow" style="height: auto; width: 18.75rem;" loading="lazy">
|
||
</a>
|
||
<a href="javascript:history.back();" class="lightbox" id="image-c55db9f763db66ebd2ef56c533290fd8">
|
||
<img src="./cont/i18n/i18n-menu.gif?classes=shadow&width=18.75rem" alt="I18n menu" class="lightbox-image" loading="lazy">
|
||
</a></p>
|
||
<h2 id="basic-configuration">Basic configuration</h2>
|
||
<p>After learning <a href="https://gohugo.io/content-management/multilingual" target="_blank">how Hugo handle multilingual websites</a>, define your languages in your <code>config.toml</code> file.</p>
|
||
<p>For example with current English and Piratized English website.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>Make sure your default language is defined as the first one in the <code>[languages]</code> array, as the theme needs to make assumptions on it</p>
|
||
</div>
|
||
</div>
|
||
<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 is the 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 Relearn 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, for each new page, append the <em>id</em> of the language to the file.</p>
|
||
<ul>
|
||
<li>Single file <code>my-page.md</code> is split in two files:
|
||
<ul>
|
||
<li>in English: <code>my-page.md</code></li>
|
||
<li>in Piratized English: <code>my-page.pir.md</code></li>
|
||
</ul>
|
||
</li>
|
||
<li>Single file <code>_index.md</code> is split in two files:
|
||
<ul>
|
||
<li>in English: <code>_index.md</code></li>
|
||
<li>in Piratized English: <code>_index.pir.md</code></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
<div class="box notices cstyle info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
|
||
<div class="box-content">
|
||
<p>Be aware that only translated pages are displayed in menu. It’s not replaced with default language content.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
<p>Use <a href="https://gohugo.io/content-management/multilingual/#translate-your-content" target="_blank">slug</a> frontmatter parameter to translate urls too.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="search">Search</h2>
|
||
<p>In case each page’s content is written in one single language only, the above configuration will already configure the site’s search functionality correctly.</p>
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Warning</div>
|
||
<div class="box-content">
|
||
<p>Although the theme supports a wide variety of supported languages, the site’s search via the <a href="https://lunrjs.com" target="_blank">Lunr</a> search library does not.
|
||
You’ll see error reports in your browsers console log for each unsupported language. Currently unsupported are:</p>
|
||
<ul>
|
||
<li>Czech</li>
|
||
<li>Indonesian</li>
|
||
<li>Polish</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<h3 id="search-with-mixed-language-support">Search with mixed language support</h3>
|
||
<p>In case your page’s content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your <code>config.toml</code> to broaden search.</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">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 is an array, you can add multiple additional languages.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in <code>zh-CN</code>, you have to add just <code>zh</code> to this parameter.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="overwrite-translation-strings">Overwrite translation strings</h2>
|
||
<p>Translations strings are used for common default values used in the theme (<em>Edit</em> button, <em>Search placeholder</em> and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.</p>
|
||
<p>To override these values, create a new file in your local i18n folder <code>i18n/<idlanguage>.toml</code> and inspire yourself from the theme <code>themes/hugo-theme-relearn/i18n/en.toml</code></p>
|
||
<h2 id="disable-language-switching">Disable language switching</h2>
|
||
<p>Switching the language in the browser is a great feature, but for some reasons you may want to disable it.</p>
|
||
<p>Just set <code>disableLanguageSwitchingButton=true</code> in your <code>config.toml</code></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">params</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># When using multilingual website, disable the switch language button.</span>
|
||
</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>
|
||
|
||
<article class="default">
|
||
<h1 id="tags">Tags</h1>
|
||
|
||
<p>The Relearn theme supports one default taxonomy of Hugo: the <em>tag</em> feature.</p>
|
||
<h2 id="configuration">Configuration</h2>
|
||
<p>Just add tags to any page:</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>The tags are displayed at the top of the page, in their insertion order.</p>
|
||
<p>Each tag is a link to a <em>Taxonomy</em> page displaying all the articles with the given tag.</p>
|
||
<h2 id="list-all-the-tags">List all the tags</h2>
|
||
<p>In the <code>config.toml</code> file you can add a shortcut to display all the 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>
|
||
|
||
</section>
|
||
<article class="chapter">
|
||
<div class="article-subheading">Chapter 3</div>
|
||
<h1 id="shortcodes">Shortcodes</h1>
|
||
|
||
<p>Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.</p>
|
||
<p>But this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.</p>
|
||
<p>To avoid this limitations, Hugo created <a href="https://gohugo.io/extras/shortcodes/" target="_blank">shortcodes</a>. A shortcode is a simple snippet inside a page.</p>
|
||
<p>The Relearn theme provides multiple shortcodes on top of existing ones.</p>
|
||
|
||
<div class="children children-h2 children-sort-">
|
||
|
||
<h2><a href="./shortcodes/attachments/index.html">Attachments</a></h2><p>List of files attached to a page</p>
|
||
<h2><a href="./shortcodes/badge/index.html">Badge</a></h2><p>Marker badges to display in your text</p>
|
||
<h2><a href="./shortcodes/button/index.html">Button</a></h2><p>Clickable buttons</p>
|
||
<h2><a href="./shortcodes/children/index.html">Children</a></h2><p>List the child pages of a page</p>
|
||
<h2><a href="./shortcodes/expand/index.html">Expand</a></h2><p>Expandable/collapsible sections of text</p>
|
||
<h2><a href="./shortcodes/icon/index.html">Icon</a></h2><p>Nice icons for your page</p>
|
||
<h2><a href="./shortcodes/include/index.html">Include</a></h2><p>Displays content from other files</p>
|
||
<h2><a href="./shortcodes/math/index.html">Math</a></h2><p>Beautiful math and chemical formulae</p>
|
||
<h2><a href="./shortcodes/mermaid/index.html">Mermaid</a></h2><p>Generate diagrams and flowcharts from text</p>
|
||
<h2><a href="./shortcodes/notice/index.html">Notice</a></h2><p>Disclaimers to help you structure your page</p>
|
||
<h2><a href="./shortcodes/openapi/index.html">OpenAPI</a></h2><p>UI for your OpenAPI / Swagger specifications</p>
|
||
<h2><a href="./shortcodes/siteparam/index.html">Site param</a></h2><p>Get value of site params</p>
|
||
<h2><a href="./shortcodes/tabs/index.html">Tabs</a></h2><p>Show content in tabbed views</p>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Shortcodes</h1>
|
||
<article class="default">
|
||
<h1 id="attachments">Attachments</h1>
|
||
|
||
<p>The <code>attachments</code> shortcode displays a list of files attached to a page with adjustable color, title and icon.</p>
|
||
|
||
<div class="box attachments cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-paperclip"></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>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
<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>
|
||
<td style="text-align:left">The style scheme used for the 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>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>color</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left">The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding 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 for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <code>Attachments</code><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>icon</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left"><a href="./shortcodes/icon/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <code>paperclip</code><br><br>If you want no icon, you have to set this parameter to <code>" "</code> (a non empty d with 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">Sorting the output in <code>asc</code>ending or <code>desc</code>ending 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 to filter the attachments by file name. For example:<br><br>- to match a file suffix of ‘jpg’, use <code>.*\.jpg</code> (not <code>*.\.jpg</code>)<br>- to match file names ending in <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>
|
||
<p>The shortcode lists files found in a specific folder. The name of the folder depends on your page type (either branch bundle, leaf bundle or page).</p>
|
||
<ol>
|
||
<li>
|
||
<p>For simple pages, attachments must be placed in a folder named like your page and ending with <code>.files</code>.</p>
|
||
<blockquote>
|
||
<ul>
|
||
<li>content
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li><strong>page.files</strong>
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
<li>page.md</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</blockquote>
|
||
</li>
|
||
<li>
|
||
<p>If your page is a branch or leaf bundle, attachments must be placed in a nested <code>_index.files</code> or <code>index.files</code> folder, accordingly.</p>
|
||
<p>For branch bundles:</p>
|
||
<blockquote>
|
||
<ul>
|
||
<li>content
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li>page
|
||
<ul>
|
||
<li>index.md</li>
|
||
<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>content
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li>page
|
||
<ul>
|
||
<li>_index.md</li>
|
||
<li><strong>_index.files</strong>
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</blockquote>
|
||
</li>
|
||
</ol>
|
||
<h3 id="multilingual">Multilingual</h3>
|
||
<p>Be aware that if you use a multilingual website, you will need to have as many folders as languages and the language code must be part of the folder name.</p>
|
||
<p>Eg. for a site in English and Piratish:</p>
|
||
<blockquote>
|
||
<ul>
|
||
<li>content
|
||
<ul>
|
||
<li>_index.en.md</li>
|
||
<li>_index.pir.md</li>
|
||
<li><strong>page.en.files</strong>
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>page.pir.files</strong>
|
||
<ul>
|
||
<li>attachment.pdf</li>
|
||
</ul>
|
||
</li>
|
||
<li>page.en.md</li>
|
||
<li>page.pir.md</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</blockquote>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="custom-title-list-of-attachments-ending-in-pdf-or-mp4">Custom Title, List of Attachments Ending in pdf or mp4</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">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>
|
||
</span></span></code></pre></div>
|
||
<div class="box attachments cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-paperclip"></i> Related <strong>files</strong></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/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>
|
||
</ul>
|
||
</div>
|
||
<h3 id="info-styled-box-descending-sort-order">Info Styled Box, Descending 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>
|
||
</span></span></code></pre></div>
|
||
<div class="box attachments cstyle info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
|
||
<ul class="box-content attachments-files">
|
||
<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>
|
||
</ul>
|
||
</div>
|
||
<h3 id="with-user-defined-color-and-font-awesome-brand-icon">With User-Defined Color and Font Awesome Brand Icon</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">icon</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 and Icons</h3>
|
||
<p>For further examples for <strong>style</strong>, <strong>color</strong>, <strong>title</strong> and <strong>icon</strong>, see the <a href="./shortcodes/notice/"><code>notice</code> shortcode</a> documentation. The parameter are working the same way for both shortcodes, besides having different defaults.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="badge">Badge</h1>
|
||
|
||
<p>The <code>badge</code> shortcode displays little markers in your text with adjustable color, title and icon.</p>
|
||
<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>
|
||
<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>
|
||
<span class="badge cstyle info badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-info-circle"></i> Info</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>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
</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">icon</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>
|
||
</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">icon</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>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</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="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>
|
||
</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>
|
||
</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>
|
||
<td style="text-align:left"><code>default</code></td>
|
||
<td style="text-align:left">The style scheme used for the 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>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>color</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left">The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding 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 for the badge title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>icon</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left"><a href="./shortcodes/icon/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</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">Arbitrary text for the badge.</td>
|
||
</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">Breaking</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> Info</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> Note</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> Tip</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> Warning</span><span class="badge-content">Breaking</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">icon</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">icon</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>
|
||
</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">icon</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>
|
||
</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>
|
||
<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>
|
||
<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">icon</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">icon</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">icon</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">icon</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">icon</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">icon</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">icon</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 Icon and 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">icon</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 Icon</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">icon</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">Info</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">icon</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>
|
||
</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">icon</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>
|
||
</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>
|
||
<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>
|
||
<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">icon</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>
|
||
</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">icon</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>
|
||
</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> Info</span><span class="badge-content">Awesome</span></span>
|
||
<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>
|
||
<h4 id="override-for-severity">Override for 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">icon</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>
|
||
<h4 id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title-and-content">With User-Defined Color, Font Awesome Brand Icon and Markdown Title and Content</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">icon</span><span class="p">=</span><span class="s">"fab fa-hackerrank"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"**Font**"</span> <span class="o">%</span><span class="p">}}</span><span class="o">**</span><span class="nx">Awesome</span><span class="o">**</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> <strong>Font</strong></span><span class="badge-content" style="background-color: fuchsia;"><strong>Awesome</strong></span></span>
|
||
<h4 id="with-icon-content">With Icon Content</h4>
|
||
<p>You can combine the badge with the <a href="./shortcodes/icon/"><code>icon</code> shortcode</a> to create even more stunning visuals.</p>
|
||
<p>In this case you need to declare <code>{{< badge >}}</code> instead of <code>{{% badge %}}</code>. Note, that in this case it is not possible to put markdown in the content.</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">badge</span> <span class="nx">style</span><span class="p">=</span><span class="s">"primary"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">icon</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">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="p">>}}{{</span><span class="o">%</span> <span class="nx">icon</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">icon</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">icon</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">icon</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">icon</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">icon</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">icon</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></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">
|
||
<i class="fa-fw fas fa-skull-crossbones"></i></span></span><br>
|
||
<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">
|
||
<i class="fa-fw fas fa-skull-crossbones"></i> Pirate</span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title">Rank</span><span class="badge-content">
|
||
<i class="fa-fw fas fa-skull-crossbones"></i></span></span><br>
|
||
<span class="badge cstyle primary badge-with-title"><span class="badge-title">Rank</span><span class="badge-content">
|
||
<i class="fa-fw fas fa-skull-crossbones"></i> Pirate</span></span><br>
|
||
<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></span></span><br>
|
||
<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>
|
||
<h4 id="inside-of-text">Inside of 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">icon</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>
|
||
|
||
<p>The <code>button</code> shortcode displays a clickable button with adjustable color, title and icon.</p>
|
||
<p>
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle warning">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-dragon"></i>
|
||
Get Hugo
|
||
</a>
|
||
</span></p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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">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">icon</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">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>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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 the button is clicked, it opens another browser tab for the given URL.</p>
|
||
<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>href</strong></td>
|
||
<td style="text-align:left"><em><empty></em></td>
|
||
<td style="text-align:left">Either the destination URL for the button or JavaScript code to be executed on click. If this parameter is not set, the button will do nothing but is still displayed as clickable.<br><br>- if starting with <code>javascript:</code> all following text will be executed in your browser<br>- every other string will be interpreted as URL</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>style</strong></td>
|
||
<td style="text-align:left"><code>transparent</code></td>
|
||
<td style="text-align:left">The style scheme used for the 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>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>color</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left">The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>icon</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left"><a href="./shortcodes/icon/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>iconposition</strong></td>
|
||
<td style="text-align:left"><code>left</code></td>
|
||
<td style="text-align:left">Places the icon to the <code>left</code> or <code>right</code> of the title.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>target</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left">The destination frame/window if <strong>href</strong> is an URL. Otherwise the parameter is not used. This behaves similar to normal links. If the parameter is not given it defaults to:<br><br>- the setting of <code>externalLinkTarget</code> or <code>_blank</code> if not set, for any address starting with <code>http://</code> or <code>https://</code><br>- no specific value for all other links</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>type</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left">The <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type" target="_blank">button type</a> if <strong>href</strong> is JavaScript. Otherwise the parameter is not used. If the parameter is not given it defaults to <code>button</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><em><strong><content></strong></em></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left">Arbitrary text for the button title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</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">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">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">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">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">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>
|
||
<span class="btn cstyle info">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-info-circle"></i>
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle note">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-exclamation-circle"></i>
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle tip">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-lightbulb"></i>
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle warning">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-exclamation-triangle"></i>
|
||
Get Hugo
|
||
</a>
|
||
</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">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">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">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">"accent"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="nx">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>
|
||
<span class="btn cstyle primary">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle secondary">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle accent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span></p>
|
||
<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">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">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">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">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">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>
|
||
<span class="btn cstyle blue">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle green">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle grey">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle orange">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle red">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</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">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">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">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>
|
||
<span class="btn cstyle default">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
</a>
|
||
</span></p>
|
||
<h3 id="icon">Icon</h3>
|
||
<h4 id="to-the-left">To the 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">icon</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">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 transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-download"></i>
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
<h4 id="to-the-right">To the Right</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">icon</span><span class="p">=</span><span class="s">"download"</span> <span class="nx">iconposition</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">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 transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo
|
||
<i class="fa-fw fas fa-download"></i>
|
||
</a>
|
||
</span>
|
||
<h4 id="override-for-severity">Override for 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">icon</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">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 warning">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-dragon"></i>
|
||
Get Hugo
|
||
</a>
|
||
</span>
|
||
<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">Hugo</span> <span class="nx">in</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">Hugo</span> <span class="nx">in</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">
|
||
<a href="https://gohugo.io/" target="_self">
|
||
Get Hugo in same Window/Frame
|
||
</a>
|
||
</span>
|
||
|
||
<span class="btn cstyle transparent">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
Get Hugo in new Window/Frame (default)
|
||
</a>
|
||
</span></p>
|
||
<h3 id="other">Other</h3>
|
||
<h4 id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title">With User-Defined Color, Font Awesome Brand Icon and Markdown Title</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">icon</span><span class="p">=</span><span class="s">"fab fa-hackerrank"</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Get</span> <span class="o">**</span><span class="nx">Hugo</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>
|
||
<span class="btn cstyle default" style="--VARIABLE-BOX-color: fuchsia;">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fab fa-hackerrank"></i>
|
||
Get <strong>Hugo</strong>
|
||
</a>
|
||
</span>
|
||
<h4 id="severity-style-with-all-defaults">Severity Style with All Defaults</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">"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>
|
||
<span class="btn cstyle tip">
|
||
<a href="https://gohugo.io/" target="_blank">
|
||
<i class="fa-fw fas fa-lightbulb"></i>
|
||
Tip
|
||
</a>
|
||
</span>
|
||
<h4 id="button-to-internal-page">Button to Internal Page</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">"/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>
|
||
</span></span></code></pre></div>
|
||
<span class="btn cstyle transparent">
|
||
<a href="./index.html">
|
||
Home
|
||
</a>
|
||
</span>
|
||
<h4 id="button-with-javascript-action">Button with JavaScript Action</h4>
|
||
<p>If your JavaScript action does not change the focus afterwards, make sure to call <code>this.blur()</code> in the end to unselect the 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">icon</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>To use native HTML elements in your Markdown, add this in your <code>config.toml</code></p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span 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">action</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>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="children">Children</h1>
|
||
|
||
<p>The <code>children</code> shortcode lists the child pages of the current page and its descendants.</p>
|
||
|
||
<ul class="children children-li children-sort-weight">
|
||
|
||
<li><a href="./shortcodes/children/test/index.html">page X</a></li>
|
||
<li><a href="./shortcodes/children/children-1/index.html">page 1</a></li>
|
||
<li><a href="./shortcodes/children/children-2/index.html">page 2</a></li>
|
||
<li><a href="./shortcodes/children/children-3/index.html">page 3</a></li>
|
||
</ul>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
<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>containerstyle</strong></td>
|
||
<td style="text-align:left"><code>ul</code></td>
|
||
<td style="text-align:left">Choose the style used to group all children. It could be any HTML tag name.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>style</strong></td>
|
||
<td style="text-align:left"><code>li</code></td>
|
||
<td style="text-align:left">Choose the style used to display each descendant. It could be any HTML tag name.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>showhidden</strong></td>
|
||
<td style="text-align:left"><code>false</code></td>
|
||
<td style="text-align:left">When <code>true</code>, child pages hidden from the menu will be displayed as well.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>description</strong></td>
|
||
<td style="text-align:left"><code>false</code></td>
|
||
<td style="text-align:left">When <code>true</code> shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - <a href="https://gohugo.io/content/summaries/" target="_blank">read more info about summaries on gohugo.io</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>depth</strong></td>
|
||
<td style="text-align:left"><code>1</code></td>
|
||
<td style="text-align:left">The depth of descendants to display. For example, if the value is <code>2</code>, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. <code>999</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>sort</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left">The sort order of the displayed list.<br><br>If not set it is sorted by the <a href="./basics/configuration/#global-site-parameters"><code>ordersectionsby</code></a> setting of the site and the pages frontmatter<br><br>- <code>weight</code>: to sort on menu order<br>- <code>title</code>: to sort alphabetically on menu label.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="all-default">All Default</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="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div>
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="./shortcodes/children/test/index.html">page X</a></li>
|
||
<li><a href="./shortcodes/children/children-1/index.html">page 1</a></li>
|
||
<li><a href="./shortcodes/children/children-2/index.html">page 2</a></li>
|
||
<li><a href="./shortcodes/children/children-3/index.html">page 3</a></li>
|
||
</ul>
|
||
<h3 id="with-description">With Description</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">description</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-">
|
||
|
||
<li><a href="./shortcodes/children/test/index.html">page X</a><p>This is a plain page test, and the beginning of a YAML multiline description...
|
||
</p></li>
|
||
<li><a href="./shortcodes/children/children-1/index.html">page 1</a><p>This is a demo child page</p></li>
|
||
<li><a href="./shortcodes/children/children-2/index.html">page 2</a><p>This is a demo child page with no description.
|
||
So its content is used as description.</p></li>
|
||
<li><a href="./shortcodes/children/children-3/index.html">page 3</a><p>This is a demo child page</p></li>
|
||
</ul>
|
||
<h3 id="infinite-depth-and-hidden-pages">Infinite Depth and Hidden Pages</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">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-">
|
||
|
||
<li><a href="./shortcodes/children/test/index.html">page X</a><ul>
|
||
</ul></li>
|
||
<li><a href="./shortcodes/children/children-1/index.html">page 1</a><ul>
|
||
|
||
<li><a href="./shortcodes/children/children-1/children-1-1/index.html">page 1-1</a><ul>
|
||
|
||
<li><a href="./shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">page 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">page 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">page 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">page 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">page 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">page 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">page 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">page 1-1-3</a><ul>
|
||
</ul></li></ul></li></ul></li>
|
||
<li><a href="./shortcodes/children/children-2/index.html">page 2</a><ul>
|
||
</ul></li>
|
||
<li><a href="./shortcodes/children/children-3/index.html">page 3</a><ul>
|
||
|
||
<li><a href="./shortcodes/children/children-3/test3/index.html">page 3-1</a><ul>
|
||
</ul></li></ul></li>
|
||
<li><a href="./shortcodes/children/children-4/index.html">page 4 (hidden)</a><ul>
|
||
</ul></li>
|
||
</ul>
|
||
<h3 id="heading-styles-for-container-and-elements">Heading Styles for Container and Elements</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">"h2"</span> <span class="nx">depth</span><span class="p">=</span><span class="s">"3"</span> <span class="nx">description</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-">
|
||
|
||
<h2><a href="./shortcodes/children/test/index.html">page X</a></h2><p>This is a plain page test, and the beginning of a YAML multiline description...
|
||
</p>
|
||
|
||
<h2><a href="./shortcodes/children/children-1/index.html">page 1</a></h2><p>This is a demo child page</p>
|
||
|
||
<h3><a href="./shortcodes/children/children-1/children-1-1/index.html">page 1-1</a></h3><p>This is a demo child page</p>
|
||
|
||
<h4><a href="./shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2</a></h4><p>This is a demo child page</p>
|
||
<h4><a href="./shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a></h4><p>This is a demo child page</p>
|
||
<h2><a href="./shortcodes/children/children-2/index.html">page 2</a></h2><p>This is a demo child page with no description.
|
||
So its content is used as description.</p>
|
||
|
||
<h2><a href="./shortcodes/children/children-3/index.html">page 3</a></h2><p>This is a demo child page</p>
|
||
|
||
<h3><a href="./shortcodes/children/children-3/test3/index.html">page 3-1</a></h3><p>This is a plain page test nested in a parent</p>
|
||
|
||
</div>
|
||
<h3 id="divs-for-group-and-element-styles">Divs for Group and 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>
|
||
</span></span></code></pre></div>
|
||
<div class="children children-div children-sort-">
|
||
|
||
<div><a href="./shortcodes/children/test/index.html">page X</a></div>
|
||
|
||
<div><a href="./shortcodes/children/children-1/index.html">page 1</a></div>
|
||
|
||
<div><a href="./shortcodes/children/children-1/children-1-1/index.html">page 1-1</a></div>
|
||
|
||
<div><a href="./shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2</a></div>
|
||
<div><a href="./shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a></div>
|
||
<div><a href="./shortcodes/children/children-2/index.html">page 2</a></div>
|
||
|
||
<div><a href="./shortcodes/children/children-3/index.html">page 3</a></div>
|
||
|
||
<div><a href="./shortcodes/children/children-3/test3/index.html">page 3-1</a></div>
|
||
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of Children</h1>
|
||
<article class="default">
|
||
<h1 id="page-x">page X</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="page-1">page 1</h1>
|
||
|
||
<p>This is a demo child page.</p>
|
||
<h2 id="subpages-of-this-page">Subpages of this page</h2>
|
||
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="./shortcodes/children/children-1/children-1-1/index.html">page 1-1</a></li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of page 1</h1>
|
||
<article class="default">
|
||
<h1 id="page-1-1">page 1-1</h1>
|
||
|
||
<p>This is a demo child page with a hidden child. You can still access the hidden child <a href="./shortcodes/children/children-1/children-1-1/children-1-1-1/">directly</a> or via the search.</p>
|
||
<h2 id="subpages-of-this-page">Subpages of this page</h2>
|
||
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="./shortcodes/children/children-1/children-1-1/children-1-1-1/index.html">page 1-1-1 (hidden)</a></li>
|
||
<li><a href="./shortcodes/children/children-1/children-1-1/children-1-1-2/index.html">page 1-1-2</a></li>
|
||
<li><a href="./shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3</a></li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of page 1-1</h1>
|
||
<article class="default">
|
||
<h1 id="page-1-1-2">page 1-1-2</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
<h2 id="subpages-of-this-page">Subpages of this page</h2>
|
||
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="./shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">page 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">page 1-1-2-2</a></li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of page 1-1-2</h1>
|
||
<article class="default">
|
||
<h1 id="page-1-1-2-1">page 1-1-2-1</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="page-1-1-2-2">page 1-1-2-2</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
<article class="default">
|
||
<h1 id="page-1-1-3">page 1-1-3</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
</section>
|
||
<article class="default">
|
||
<h1 id="page-2">page 2</h1>
|
||
|
||
<p>This is a demo child page with no description.</p>
|
||
<p>So its content is used as description.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="page-3">page 3</h1>
|
||
|
||
<p>This is a demo child page.</p>
|
||
<h2 id="subpages-of-this-page">Subpages of this page</h2>
|
||
|
||
<ul class="children children-li children-sort-">
|
||
|
||
<li><a href="./shortcodes/children/children-3/test3/index.html">page 3-1</a></li>
|
||
</ul>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<section>
|
||
<h1 class="a11y-only">Subsections of page 3</h1>
|
||
<article class="default">
|
||
<h1 id="page-3-1">page 3-1</h1>
|
||
|
||
<p>This is a plain demo child page.</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
</section>
|
||
<article class="default">
|
||
<h1 id="expand">Expand</h1>
|
||
|
||
<p>The <code>expand</code> shortcode displays an expandable/collapsible section of text.</p>
|
||
|
||
<div class="expand">
|
||
<input type="checkbox" id="expand-29e7b0a9f9181bf72dec1a651aceaa9a" aria-controls="expandcontent-29e7b0a9f9181bf72dec1a651aceaa9a" >
|
||
<label class="expand-label" for="expand-29e7b0a9f9181bf72dec1a651aceaa9a" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Expand me…
|
||
</label>
|
||
<div id="expandcontent-29e7b0a9f9181bf72dec1a651aceaa9a" class="expand-content">
|
||
Thank you!
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>This only works in modern browsers flawlessly. While Internet Explorer 11 has issues in displaying it, the functionality still works.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
|
||
>
|
||
<span>shortcode (positional)</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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">you</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>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-content-text"
|
||
>
|
||
<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">you</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>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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 you!"</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">Position</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>
|
||
<td style="text-align:left">Arbitrary text to appear next to the expand/collapse icon.</td>
|
||
</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> the content 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>
|
||
<td style="text-align:left">Arbitrary text to be displayed on expand.</td>
|
||
</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">you</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>
|
||
<div class="expand">
|
||
<input type="checkbox" id="expand-dc6b40a19781f72fa54cdcec1a2b40a9" aria-controls="expandcontent-dc6b40a19781f72fa54cdcec1a2b40a9" >
|
||
<label class="expand-label" for="expand-dc6b40a19781f72fa54cdcec1a2b40a9" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Expand me…
|
||
</label>
|
||
<div id="expandcontent-dc6b40a19781f72fa54cdcec1a2b40a9" class="expand-content">
|
||
Yes, you did it!
|
||
</div>
|
||
</div>
|
||
<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">to</span> <span class="nx">press</span> <span class="nx">you</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>
|
||
<div class="expand">
|
||
<input type="checkbox" id="expand-febb8629c895bbb08811e94120d652c4" aria-controls="expandcontent-febb8629c895bbb08811e94120d652c4" checked>
|
||
<label class="expand-label" for="expand-febb8629c895bbb08811e94120d652c4" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Expand me…
|
||
</label>
|
||
<div id="expandcontent-febb8629c895bbb08811e94120d652c4" class="expand-content">
|
||
No need to press you!
|
||
</div>
|
||
</div>
|
||
<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">You</span> <span class="nx">can</span> <span class="nx">add</span> <span class="nx">standard</span> <span class="nx">markdown</span> <span class="nx">syntax</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">and</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">
|
||
</span></span><span class="line"><span class="cl"><span class="p">></span> <span class="nx">the</span> <span class="nx">possibilities</span> <span class="nx">are</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">including</span> <span class="nx">other</span> <span class="nx">shortcodes</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>
|
||
</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">
|
||
<input type="checkbox" id="expand-461ace6833405d2e46e088beda6acf5c" aria-controls="expandcontent-461ace6833405d2e46e088beda6acf5c" >
|
||
<label class="expand-label" for="expand-461ace6833405d2e46e088beda6acf5c" >
|
||
<i class="fas fa-chevron-down"></i>
|
||
<i class="fas fa-chevron-right"></i>
|
||
Show me almost <strong>endless</strong> possibilities
|
||
</label>
|
||
<div id="expandcontent-461ace6833405d2e46e088beda6acf5c" class="expand-content">
|
||
<p>You can add standard markdown syntax:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
|
||
<li><a href="https://example.com" target="_blank">links</a></li>
|
||
<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>
|
||
<p>the possibilities are endless (almost - including other shortcodes may or may not work)</p>
|
||
</blockquote>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="icon">Icon</h1>
|
||
|
||
<p>The <code>icon</code> shortcode displays icons using the <a href="https://fontawesome.com" target="_blank">Font Awesome</a> library.</p>
|
||
<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>
|
||
<p>While the examples are using shortcodes with positional parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
|
||
>
|
||
<span>shortcode (positional)</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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">icon</span> <span class="nx">icon</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">icon</span> <span class="nx">icon</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">icon</span> <span class="nx">icon</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>
|
||
<div
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-content-text"
|
||
>
|
||
<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">icon</span> <span class="nx">exclamation</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">icon</span> <span class="nx">angle</span><span class="o">-</span><span class="nx">double</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">icon</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>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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">Position</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>icon</strong></td>
|
||
<td style="text-align:left">1</td>
|
||
<td style="text-align:left"><em><empty></em></td>
|
||
<td style="text-align:left"><a href="#finding-an-icon">Font Awesome icon name</a> to be displayed. It will be displayed in the text color of its according context.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h3 id="finding-an-icon">Finding an icon</h3>
|
||
<p>Browse through the available icons in the <a href="https://fontawesome.com/v5/search?m=free" target="_blank">Font Awesome Gallery</a>. Notice that the <strong>free</strong> filter is enabled, as only the free icons are available by default.</p>
|
||
<p>Once on the Font Awesome page for a specific icon, for example the page for the <a href="https://fontawesome.com/v5/icons/heart?s=solid" target="_blank">heart</a>, copy the icon name and paste into the Markdown content.</p>
|
||
<h3 id="customising-icons">Customising Icons</h3>
|
||
<p>Font Awesome provides many ways to modify the icon</p>
|
||
<ul>
|
||
<li>Change color (by default the icon will inherit the parent color)</li>
|
||
<li>Increase or decrease size</li>
|
||
<li>Rotate</li>
|
||
<li>Combine with other icons</li>
|
||
</ul>
|
||
<p>Check the full documentation on <a href="https://fontawesome.com/how-to-use/web-fonts-with-css" target="_blank">web fonts with CSS</a> for more.</p>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="standard-usage">Standard Usage</h3>
|
||
<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">with</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">heart</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">by</span> <span class="nx">Relearn</span> <span class="nx">and</span> <span class="nx">Hugo</span>
|
||
</span></span></code></pre></div><p>Built with
|
||
<i class="fa-fw fas fa-heart"></i> by Relearn and Hugo</p>
|
||
<h3 id="advanced-html-usage">Advanced HTML Usage</h3>
|
||
<p>While the shortcode simplyfies using standard icons, the icon customisation and other advanced features of the Font Awesome library requires you to use HTML directly. Just paste the <code><i></code> HTML into markup and Font Awesome will load the relevant icon.</p>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl">Built with <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 Relearn and Hugo
|
||
</span></span></code></pre></div><p>Built with <i class="fas fa-heart"></i> by Relearn and Hugo</p>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="include">Include</h1>
|
||
|
||
<p>The <code>include</code> shortcode includes other files from your project inside of the current page.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
|
||
>
|
||
<span>shortcode (positional)</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
<div
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>The included files can even contain Markdown and will be taken into account when generating the table of contents.</p>
|
||
<h3 id="parameter">Parameter</h3>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th style="text-align:left">Name</th>
|
||
<th style="text-align:left">Position</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>
|
||
<td style="text-align:left">The path to the file to be included. Path resolution adheres to <a href="https://gohugo.io/functions/readfile/" target="_blank">Hugo’s build-in <code>readFile</code> function</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>hidefirstheading</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> and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="arbitrary-content">Arbitrary Content</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">include</span> <span class="s">"shortcodes/INCLUDE_ME.md"</span> <span class="o">%</span><span class="p">}}</span>
|
||
</span></span></code></pre></div><p>You can add standard markdown syntax:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
|
||
<li><a href="https://example.com" target="_blank">links</a></li>
|
||
<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>
|
||
<p>the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)</p>
|
||
</blockquote>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="math">Math</h1>
|
||
|
||
<p>The <code>math</code> shortcode generates beautiful formatted math and chemical formulae using the <a href="https://mathjax.org/" target="_blank">MathJax</a> library.</p>
|
||
|
||
<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>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>This only works in modern browsers.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable.</p>
|
||
<p>You are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting (<a href="#configuration">see the configuration section</a>).</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="codefence"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','codefence')"
|
||
>
|
||
<span>codefence</span></button>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="codefence"
|
||
class="tab-content-text active"
|
||
>
|
||
<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">```
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</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>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"align"</span> <span class="s">"center"</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>align</strong></td>
|
||
<td style="text-align:left"><code>center</code></td>
|
||
<td style="text-align:left">Allowed values are <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">Your formuale.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="configuration">Configuration</h2>
|
||
<p>MathJax is configured with default settings. You can customize MathJax’s default settings for all of your files thru a JSON object in your <code>config.toml</code> or override these settings per page thru your pages frontmatter.</p>
|
||
<p>The JSON object of your <code>config.toml</code> / frontmatter is forwarded into MathJax’s configuration object.</p>
|
||
<p>See <a href="https://docs.mathjax.org/en/latest/options/index.html" target="_blank">MathJax documentation</a> for all allowed settings.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="global-configuration-file">Global Configuration 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">markup</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">highlight</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># if `guessSyntax = true`, there will be no unstyled code even if no language</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># was given BUT Mermaid and Math codefences will not work anymore! So this is a</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># mandatory setting for your site if you want to use Math codefences</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">guessSyntax</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span></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 is generated if you use a single <span class="sb">`$`</span> as a delimiter around your 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 is generated if you use a single <code>$</code> as a delimiter around your formulae:
|
||
<span class="math align-center">$\sqrt{3}$</span></p>
|
||
<h3 id="blocklevel-math-with-right-alignment">Blocklevel Math with Right Alignment</h3>
|
||
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">If you delimit your formulae by two consecutive <span class="sb">`$$`</span> it generates a new block.
|
||
</span></span><span class="line"><span class="cl">
|
||
</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>}}
|
||
</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 you delimit your formulae by two consecutive <code>$$</code> it generates a new block.</p>
|
||
|
||
<span class="math align-right">
|
||
$$\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>
|
||
<p>You can also use codefences.</p>
|
||
<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>
|
||
<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>
|
||
<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>
|
||
|
||
<article class="default">
|
||
<h1 id="mermaid">Mermaid</h1>
|
||
|
||
<p>The <code>mermaid</code> shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the <a href="https://mermaidjs.github.io/" target="_blank">Mermaid</a> library.</p>
|
||
|
||
<div class="mermaid align-center zoom">
|
||
graph LR;
|
||
If --> Then
|
||
Then --> Else
|
||
</div>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>This only works in modern browsers.</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Warning</div>
|
||
<div class="box-content">
|
||
<p>Due to limitations with <a href="https://github.com/mermaid-js/mermaid/issues/1846" target="_blank">Mermaid</a>, it is currently not possible to use Mermaid code fences in an initially collapsed <code>expand</code> shortcode. This is a know issue and <a href="https://github.com/McShelby/hugo-theme-relearn/issues/187" target="_blank">can’t be fixed by this theme</a>.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.</p>
|
||
<p>You are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting (<a href="#configuration">see the configuration section</a>).</p>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="codefence"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','codefence')"
|
||
>
|
||
<span>codefence</span></button>
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="codefence"
|
||
class="tab-content-text active"
|
||
>
|
||
<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" }
|
||
</span></span><span class="line"><span class="cl">graph LR;
|
||
</span></span><span class="line"><span class="cl"> If --> Then
|
||
</span></span><span class="line"><span class="cl"> Then --> Else
|
||
</span></span><span class="line"><span class="cl">```
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</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>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"align"</span> <span class="s">"center"</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="s">"zoom"</span> <span class="s">"true"</span>
|
||
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<p>The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.</p>
|
||
<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 are <code>left</code>, <code>center</code> or <code>right</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>zoom</strong></td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left">Whether the graph is pan- and zoomable.<br><br>If not set the value is determined by the <code>mermaidZoom</code> setting of the <a href="#global-configuration-file">site</a> or the <a href="#pages-frontmatter">pages 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 and zoom active</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">Your Mermaid graph.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="configuration">Configuration</h2>
|
||
<p>Mermaid is configured with default settings. You can customize Mermaid’s default settings for all of your files thru a JSON object in your <code>config.toml</code>, override these settings per page thru your pages frontmatter or override these setting per diagramm thru <a href="https://mermaid-js.github.io/mermaid/#/directives?id=directives" target="_blank">diagram directives</a>.</p>
|
||
<p>The JSON object of your <code>config.toml</code> / frontmatter is forwarded into Mermaid’s <code>mermaid.initialize()</code> function.</p>
|
||
<p>See <a href="https://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults" target="_blank">Mermaid documentation</a> for all allowed settings.</p>
|
||
<p>The <code>theme</code> setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in <code>config.toml</code>, frontmatter or diagram directives.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>To use codefence syntax you have to turn off <code>guessSyntax</code> for the <code>markup.highlight</code> setting.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="global-configuration-file">Global Configuration 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>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="p">[</span><span class="nx">markup</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">highlight</span><span class="p">]</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># if `guessSyntax = true`, there will be no unstyled code even if no language</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># was given BUT Mermaid and Math codefences will not work anymore! So this is a</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="c"># mandatory setting for your site if you want to use Mermaid codefences</span>
|
||
</span></span><span class="line"><span class="cl"> <span class="nx">guessSyntax</span> <span class="p">=</span> <span class="kc">false</span>
|
||
</span></span></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>
|
||
</span></span><span class="line"><span class="cl"><span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span>
|
||
</span></span><span class="line"><span class="cl"><span class="err">+++</span>
|
||
</span></span></code></pre></div><h2 id="examples">Examples</h2>
|
||
<h3 id="flowchart-with-non-default-mermaid-theme">Flowchart with Non-Default Mermaid Theme</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">"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>
|
||
<div class="mermaid align-center zoom">
|
||
%%{init:{"theme":"forest"}}%%
|
||
graph LR;
|
||
A[Hard edge] -->|Link text| B(Round edge)
|
||
B --> C{<strong>Decision</strong>}
|
||
C -->|One| D[Result one]
|
||
C -->|Two| E[Result two]
|
||
</div>
|
||
<h3 id="sequence-diagram-with-configuration-directive">Sequence Diagram with Configuration 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">are</span> <span class="nx">you</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">Note</span> <span class="nx">right</span> <span class="nx">of</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">you</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">good</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>
|
||
<div class="mermaid align-center zoom">
|
||
%%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%%
|
||
sequenceDiagram
|
||
Alice->>John: Hello John, how are you?
|
||
loop Healthcheck
|
||
John->>John: Fight against hypochondria
|
||
end
|
||
Note right of John: Rational thoughts!
|
||
John-->>Alice: Great!
|
||
John->>Bob: How about you?
|
||
Bob-->>John: Jolly good!
|
||
</div>
|
||
<h3 id="class-diagram-with-codefence-syntax">Class Diagram with Codefence Syntax</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 : +String 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"> +String 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>
|
||
<div class="mermaid align-center zoom">classDiagram
|
||
Animal <|-- Duck
|
||
Animal <|-- Fish
|
||
Animal <|-- Zebra
|
||
Animal : +int age
|
||
Animal : +String gender
|
||
Animal: +isMammal()
|
||
Animal: +mate()
|
||
class Duck{
|
||
+String 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 to the 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>
|
||
<div class="mermaid align-right zoom">
|
||
stateDiagram-v2
|
||
open: Open Door
|
||
closed: Closed Door
|
||
locked: Locked Door
|
||
open --> closed: Close
|
||
closed --> locked: Lock
|
||
locked --> closed: Unlock
|
||
closed --> open: Open
|
||
</div>
|
||
<h3 id="entity-relationship-model">Entity Relationship Model</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">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">"liable 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>
|
||
</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>
|
||
<div class="mermaid align-center zoom">
|
||
erDiagram
|
||
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
|
||
CUSTOMER ||--o{ ORDER : places
|
||
CUSTOMER ||--o{ INVOICE : "liable 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">working</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">to</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>
|
||
<div class="mermaid align-center zoom">
|
||
journey
|
||
title My working day
|
||
section Go to 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
|
||
</div>
|
||
<h3 id="gantt-chart">GANTT Chart</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">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">Adding</span> <span class="nx">GANTT</span> <span class="nx">diagram</span> <span class="nx">functionality</span> <span class="nx">to</span> <span class="nx">Mermaid</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">after</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">after</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">in</span> <span class="nx">the</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">and</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">after</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">for</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">in</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">for</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">to</span> <span class="nx">Mermaid</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>
|
||
<div class="mermaid align-center zoom">
|
||
gantt
|
||
dateFormat YYYY-MM-DD
|
||
title Adding GANTT diagram functionality to Mermaid
|
||
section A section
|
||
Completed task :done, des1, 2014-01-06,2014-01-08
|
||
Active task :active, des2, 2014-01-09, 3d
|
||
Future task : des3, after des2, 5d
|
||
Future task2 : des4, after des3, 5d
|
||
section Critical tasks
|
||
Completed task in the critical line :crit, done, 2014-01-06,24h
|
||
Implement parser and jison :crit, done, after des1, 2d
|
||
Create tests for parser :crit, active, 3d
|
||
Future task in critical line :crit, 5d
|
||
Create tests for renderer :2d
|
||
Add to Mermaid :1d
|
||
</div>
|
||
<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>
|
||
</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>
|
||
</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>
|
||
<div class="mermaid align-center">
|
||
pie title Pets adopted by volunteers
|
||
"Dogs" : 386
|
||
"Cats" : 85
|
||
"Rats" : 15
|
||
</div>
|
||
<h3 id="requirement-diagram">Requirement Diagram</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">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">the</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">simulation</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>
|
||
</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>
|
||
<div class="mermaid align-center zoom">
|
||
requirementDiagram
|
||
|
||
requirement test_req {
|
||
id: 1
|
||
text: the test text.
|
||
risk: high
|
||
verifymethod: test
|
||
}
|
||
|
||
element test_entity {
|
||
type: simulation
|
||
}
|
||
|
||
test_entity - satisfies -> test_req
|
||
</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>
|
||
<div class="mermaid align-center zoom">
|
||
gitGraph
|
||
commit
|
||
commit
|
||
branch develop
|
||
checkout develop
|
||
commit
|
||
commit
|
||
checkout main
|
||
merge develop
|
||
commit
|
||
commit
|
||
</div>
|
||
<h3 id="c4-diagrams">C4 Diagrams</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">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">for</span> <span class="nx">Internet</span> <span class="nx">Banking</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">"Banking Customer A"</span><span class="p">,</span> <span class="s">"A customer of the bank, with 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">"Banking 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">"Banking 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">"Banking Customer D"</span><span class="p">,</span> <span class="s">"A customer of the bank, <br/> with 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 Banking System"</span><span class="p">,</span> <span class="s">"Allows customers to view information about their bank accounts, and 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 Banking System"</span><span class="p">,</span> <span class="s">"Stores all of the core banking information about customers, accounts, transactions, 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">"Banking 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">"Banking System B"</span><span class="p">,</span> <span class="s">"A system of the bank, with 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">"Banking System D Database"</span><span class="p">,</span> <span class="s">"A system of the bank, with 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">"Banking System F Queue"</span><span class="p">,</span> <span class="s">"A system of the 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">"Banking System G Queue"</span><span class="p">,</span> <span class="s">"A system of the bank, with 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>
|
||
</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>
|
||
<div class="mermaid align-center zoom">
|
||
C4Context
|
||
title System Context diagram for Internet Banking System
|
||
Enterprise_Boundary(b0, "BankBoundary0") {
|
||
Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
|
||
Person(customerB, "Banking Customer B")
|
||
Person_Ext(customerC, "Banking Customer C", "desc")
|
||
|
||
Person(customerD, "Banking Customer D", "A customer of the bank, <br/> with personal bank accounts.")
|
||
|
||
System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")
|
||
|
||
Enterprise_Boundary(b1, "BankBoundary") {
|
||
|
||
SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")
|
||
|
||
System_Boundary(b2, "BankBoundary2") {
|
||
System(SystemA, "Banking System A")
|
||
System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts. next line.")
|
||
}
|
||
|
||
System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
|
||
SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")
|
||
|
||
Boundary(b3, "BankBoundary3", "boundary") {
|
||
SystemQueue(SystemF, "Banking System F Queue", "A system of the bank.")
|
||
SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with 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")
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="notice">Notice</h1>
|
||
|
||
<p>The <code>notice</code> shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page.</p>
|
||
|
||
<div class="box notices cstyle primary">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> There may be pirates</div>
|
||
<div class="box-content">
|
||
<p>It is all about the boxes.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
|
||
>
|
||
<span>shortcode (positional)</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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">icon</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">is</span> <span class="nx">all</span> <span class="nx">about</span> <span class="nx">the</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>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-content-text"
|
||
>
|
||
<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">is</span> <span class="nx">all</span> <span class="nx">about</span> <span class="nx">the</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>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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 is all about the boxes."</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">Position</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>
|
||
<td style="text-align:left">The style scheme used for the 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>
|
||
</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">The <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target="_blank">CSS color value</a> to be used. If not set, the chosen color depends on the <strong>style</strong>. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color</td>
|
||
</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>
|
||
<td style="text-align:left">Arbitrary text for the box title. Depending on the <strong>style</strong> there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no title for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:left"><strong>icon</strong></td>
|
||
<td style="text-align:left">3</td>
|
||
<td style="text-align:left">see notes</td>
|
||
<td style="text-align:left"><a href="./shortcodes/icon/#finding-an-icon">Font Awesome icon name</a> set to the left of the title. Depending on the <strong>style</strong> there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other styles: <em><empty></em><br><br>If you want no icon for a severity style, you have to set this parameter to <code>" "</code> (a non empty string filled with spaces)</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>
|
||
<td style="text-align:left">Arbitrary text to be displayed in box.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<h3 id="by-severity">By Severity</h3>
|
||
<h4 id="info-with-markup">Info with markup</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">information</span><span class="o">**</span> <span class="nx">disclaimer</span>
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"><span class="nx">You</span> <span class="nx">can</span> <span class="nx">add</span> <span class="nx">standard</span> <span class="nx">markdown</span> <span class="nx">syntax</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">and</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">
|
||
</span></span><span class="line"><span class="cl"><span class="p">></span> <span class="nx">the</span> <span class="nx">possibilities</span> <span class="nx">are</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">including</span> <span class="nx">other</span> <span class="nx">shortcodes</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>
|
||
</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 info">
|
||
<div class="box-label"><i class="fa-fw fas fa-info-circle"></i> Info</div>
|
||
<div class="box-content">
|
||
<p>An <strong>information</strong> disclaimer</p>
|
||
<p>You can add standard markdown syntax:</p>
|
||
<ul>
|
||
<li>multiple paragraphs</li>
|
||
<li>bullet point lists</li>
|
||
<li><em>emphasized</em>, <strong>bold</strong> and even <strong><em>bold emphasized</em></strong> text</li>
|
||
<li><a href="https://example.com" target="_blank">links</a></li>
|
||
<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>
|
||
<p>the possibilities are endless (almost - including other shortcodes may or may not work)</p>
|
||
</blockquote>
|
||
</div>
|
||
</div>
|
||
<h4 id="note">Note</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">"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>
|
||
</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 note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>A <strong>notice</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="tip">Tip</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">"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>
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
<p>A <strong>tip</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="warning">Warning</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>
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-triangle"></i> Warning</div>
|
||
<div class="box-content">
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="warning-with-non-default-title-and-icon">Warning with Non-Default Title and Icon</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="nx">title</span><span class="p">=</span><span class="s">"Here are dragons"</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"dragon"</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>
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"><i class="fa-fw fas fa-dragon"></i> Here are dragons</div>
|
||
<div class="box-content">
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="warning-without-a-title-and-icon">Warning without a Title and Icon</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="nx">title</span><span class="p">=</span><span class="s">" "</span> <span class="nx">icon</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>
|
||
<div class="box notices cstyle warning">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
<p>A <strong>warning</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="by-brand-colors">By Brand Colors</h3>
|
||
<h4 id="primary-with-title-only">Primary with 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">"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>
|
||
<div class="box notices cstyle primary">
|
||
<div class="box-label">Primary</div>
|
||
<div class="box-content">
|
||
<p>A <strong>primary</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="secondary-with-icon-only">Secondary with Icon 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">icon</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>
|
||
</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 secondary">
|
||
<div class="box-label"><i class="fa-fw fas fa-stopwatch"></i></div>
|
||
<div class="box-content">
|
||
<p>A <strong>secondary</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<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>
|
||
<h3 id="by-color">By Color</h3>
|
||
<h4 id="blue-without-a-title-and-icon">Blue without a Title and Icon</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">"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>
|
||
<div class="box notices cstyle blue">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
<p>A <strong>blue</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="green-with-title-only">Green with 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>
|
||
</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 green">
|
||
<div class="box-label">Green</div>
|
||
<div class="box-content">
|
||
<p>A <strong>green</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="grey-with-icon-only">Grey with Icon 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">icon</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>
|
||
</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 grey">
|
||
<div class="box-label"><i class="fa-fw fas fa-bug"></i></div>
|
||
<div class="box-content">
|
||
<p>A <strong>grey</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="orange-with-title-and-icon">Orange with Title and Icon</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">icon</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>
|
||
</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 orange">
|
||
<div class="box-label"><i class="fa-fw fas fa-bug"></i> Orange</div>
|
||
<div class="box-content">
|
||
<p>A <strong>orange</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="red-without-a-title-and-icon">Red without a Title and Icon</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">"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>
|
||
</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 red">
|
||
<div class="box-label"></div>
|
||
<div class="box-content">
|
||
<p>A <strong>red</strong> disclaimer</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="by-special-color">By Special Color</h3>
|
||
<h4 id="default-with-positional-parameter">Default with 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 Attention to this Note!"</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">Some</span> <span class="nx">serious</span> <span class="nx">information</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>
|
||
<div class="box notices cstyle default">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Pay Attention to this Note!</div>
|
||
<div class="box-content">
|
||
<p>Some serious information.</p>
|
||
</div>
|
||
</div>
|
||
<h4 id="transparent-with-title-and-icon">Transparent with Title and Icon</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">"transparent"</span> <span class="nx">title</span><span class="p">=</span><span class="s">"Pay Attention to this Note!"</span> <span class="nx">icon</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">Some</span> <span class="nx">serious</span> <span class="nx">information</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>
|
||
<div class="box notices cstyle transparent">
|
||
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Pay Attention to this Note!</div>
|
||
<div class="box-content">
|
||
<p>Some serious information.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="with-user-defined-color-font-awesome-brand-icon-and-markdown-title">With User-Defined Color, Font Awesome Brand Icon and Markdown Title</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">icon</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">Is</span> <span class="nx">it</span> <span class="nx">you</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> <strong>Hugo</strong></div>
|
||
<div class="box-content">
|
||
<p>Victor? Is it you?</p>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="openapi">OpenAPI</h1>
|
||
|
||
<p>The <code>openapi</code> shortcode uses the <a href="https://github.com/swagger-api/swagger-ui" target="_blank">Swagger UI</a> library to display your OpenAPI / Swagger specifications.</p>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>This only works in modern browsers.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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">openapi</span> <span class="nx">src</span><span class="p">=</span><span class="s">"https://petstore3.openapi.io/api/v3/openapi.json"</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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/openapi.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.openapi.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>
|
||
<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">The URL to the OpenAPI specification file. This can be relative to the URL of your page if it is a leaf or branch bundle.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>If you want to print out (or generate a PDF) from your OpenAPI documentation, don’t initiate printing directly from the page because the elements are optimized for interactive usage in a browser.</p>
|
||
<p>Instead, open the <a href="./basics/configuration/#activate-print-support">print preview</a> in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="example">Example</h2>
|
||
<h3 id="using-local-file">Using Local File</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">openapi</span> <span class="nx">src</span><span class="p">=</span><span class="s">"petstore.json"</span> <span class="p">>}}</span>
|
||
</span></span></code></pre></div>
|
||
<div class="sc-openapi-wrapper is-loading helper-loading-container">
|
||
<div
|
||
class="sc-openapi-container"
|
||
id="openapi-9799a1c2f05e4d023838f4818436d902"
|
||
openapi-url="./shortcodes/openapi/petstore.json"
|
||
></div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="site-param">Site param</h1>
|
||
|
||
<p>The <code>siteparam</code> shortcode prints values of site params.</p>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to use positional aswell or call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
|
||
>
|
||
<span>shortcode (positional)</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
<div
|
||
data-tab-item="shortcode (positional)"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</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">Position</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">The name of the site param to be displayed.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="examples">Examples</h2>
|
||
<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>
|
||
</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>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
<article class="default">
|
||
<h1 id="tabs">Tabs</h1>
|
||
|
||
<p>The <code>tabs</code> shortcode displays arbitrary content in unlimited number of tabs.</p>
|
||
<p>This comes in handy eg. for providing code snippets for multiple languages or providing configuration in different formats.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="tabs-example-language">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('tabs-example-language','python')"
|
||
>
|
||
<span>python</span></button>
|
||
<button
|
||
data-tab-item="bash"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('tabs-example-language','bash')"
|
||
>
|
||
<span>bash</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="python"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
<div
|
||
data-tab-item="bash"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
<h2 id="usage">Usage</h2>
|
||
<p>While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.</p>
|
||
|
||
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="shortcode"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('shortcode-parameter','shortcode')"
|
||
>
|
||
<span>shortcode</span></button>
|
||
<button
|
||
data-tab-item="partial"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('shortcode-parameter','partial')"
|
||
>
|
||
<span>partial</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="shortcode"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
</span></span></code></pre></div>
|
||
</div>
|
||
<div
|
||
data-tab-item="partial"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
<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>groupid</strong></td>
|
||
<td style="text-align:left"><code>default</code></td>
|
||
<td style="text-align:left">Arbitrary name of the group the tab view belongs to.<br><br>Tab views with the same <strong>groupid</strong> sychronize their selected tab. This sychronization applies to the whole site!</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">Arbitrary number of tabs defined with the <code>tab</code> sub-shortcode.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
<p>When using tab views with different content sets, make sure to use a common <code>groupid</code> for equal sets of tabs but distinct <code>groupid</code> for different sets.</p>
|
||
<p>The tab selection is restored automatically based on the <code>groupid</code> and if it cannot find a tab item because it came from the <code>'default'</code> group on a different page then the first tab is selected instead.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="examples">Examples</h2>
|
||
<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>
|
||
</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>
|
||
</span></span></code></pre></div>
|
||
<div class="tab-panel" data-tab-group="tabs-example-config">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="json"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('tabs-example-config','json')"
|
||
>
|
||
<span>json</span></button>
|
||
<button
|
||
data-tab-item="XML"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('tabs-example-config','XML')"
|
||
>
|
||
<span>XML</span></button>
|
||
<button
|
||
data-tab-item="properties"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('tabs-example-config','properties')"
|
||
>
|
||
<span>properties</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="json"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
<div
|
||
data-tab-item="XML"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
<div
|
||
data-tab-item="properties"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
<h3 id="non-distinct-groupid">Non-Distinct <code>groupid</code></h3>
|
||
<p>See what happens to this tab view if you select <strong>properties</strong> tab from the previous example.</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">"config"</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">"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>
|
||
<div class="tab-panel" data-tab-group="tabs-example-config">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="json"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('tabs-example-config','json')"
|
||
>
|
||
<span>json</span></button>
|
||
<button
|
||
data-tab-item="XML"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('tabs-example-config','XML')"
|
||
>
|
||
<span>XML</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="json"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
<div
|
||
data-tab-item="XML"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
</div>
|
||
</div>
|
||
<h3 id="nested-tabs">Nested Tabs</h3>
|
||
<p>In case you want to nest tabs, the parent tab that contains the subtabs needs to be declared with <code>{{< tab >}}</code> instead of <code>{{% tab %}}</code>. Note, that in this case it is not possible to put markdown in the 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">is</span> <span class="nx">possible</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">is</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">of</span> <span class="nx">the</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">you</span> <span class="nx">don</span><span class="err">'</span><span class="nx">t</span> <span class="nx">want</span> <span class="nx">to</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">is</span> <span class="k">for</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>
|
||
<div class="tab-panel" data-tab-group="main">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="Text"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('main','Text')"
|
||
>
|
||
<span>Text</span></button>
|
||
<button
|
||
data-tab-item="Code"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('main','Code')"
|
||
>
|
||
<span>Code</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="Text"
|
||
class="tab-content-text active"
|
||
>
|
||
|
||
Simple text is possible here...
|
||
|
||
<div class="tab-panel" data-tab-group="tabs-example-language">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('tabs-example-language','python')"
|
||
>
|
||
<span>python</span></button>
|
||
<button
|
||
data-tab-item="bash"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('tabs-example-language','bash')"
|
||
>
|
||
<span>bash</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="python"
|
||
class="tab-content-text active"
|
||
>
|
||
<p>Python is <strong>super</strong> easy.</p>
|
||
<ul>
|
||
<li>most of the time.</li>
|
||
<li>if you don’t want to output unicode</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div
|
||
data-tab-item="bash"
|
||
class="tab-content-text"
|
||
>
|
||
<p>Bash is for <strong>hackers</strong>.</p>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
<div
|
||
data-tab-item="Code"
|
||
class="tab-content-text"
|
||
>
|
||
|
||
...but no markdown
|
||
|
||
<div class="tab-panel" data-tab-group="tabs-example-language">
|
||
<div class="tab-nav">
|
||
<button
|
||
data-tab-item="python"
|
||
class="tab-nav-button active"
|
||
onclick="switchTab('tabs-example-language','python')"
|
||
>
|
||
<span>python</span></button>
|
||
<button
|
||
data-tab-item="bash"
|
||
class="tab-nav-button"
|
||
onclick="switchTab('tabs-example-language','bash')"
|
||
>
|
||
<span>bash</span></button>
|
||
</div>
|
||
<div class="tab-content">
|
||
<div
|
||
data-tab-item="python"
|
||
class="tab-content-text active"
|
||
>
|
||
<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>
|
||
<div
|
||
data-tab-item="bash"
|
||
class="tab-content-text"
|
||
>
|
||
<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>
|
||
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<footer class="footline">
|
||
</footer>
|
||
</article>
|
||
|
||
</section>
|
||
</section>
|
||
</div>
|
||
</main>
|
||
</div>
|
||
<script src="./js/clipboard.min.js?1684361616" defer></script>
|
||
<script src="./js/perfect-scrollbar.min.js?1684361616" defer></script>
|
||
<script>
|
||
function useMathJax( config ){
|
||
if( !Object.assign ){
|
||
|
||
return;
|
||
}
|
||
window.MathJax = Object.assign( window.MathJax || {}, {
|
||
loader: {
|
||
load: ['[tex]/mhchem']
|
||
},
|
||
startup: {
|
||
elements: [
|
||
'.math'
|
||
]
|
||
},
|
||
tex: {
|
||
inlineMath: [
|
||
['$', '$'],
|
||
['\\(', '\\)']
|
||
]
|
||
},
|
||
options: {
|
||
enableMenu: false
|
||
}
|
||
}, config );
|
||
}
|
||
useMathJax( JSON.parse("{}") );
|
||
</script>
|
||
<script id="MathJax-script" async src="./js/mathjax/tex-mml-chtml.js?1684361616"></script>
|
||
<script src="./js/d3/d3-color.min.js?1684361616" defer></script>
|
||
<script src="./js/d3/d3-dispatch.min.js?1684361616" defer></script>
|
||
<script src="./js/d3/d3-drag.min.js?1684361616" defer></script>
|
||
<script src="./js/d3/d3-ease.min.js?1684361616" defer></script>
|
||
<script src="./js/d3/d3-interpolate.min.js?1684361616" defer></script>
|
||
<script src="./js/d3/d3-selection.min.js?1684361616" defer></script>
|
||
<script src="./js/d3/d3-timer.min.js?1684361616" defer></script>
|
||
<script src="./js/d3/d3-transition.min.js?1684361616" defer></script>
|
||
<script src="./js/d3/d3-zoom.min.js?1684361616" defer></script>
|
||
<script src="./js/mermaid.min.js?1684361616" defer></script>
|
||
<script>
|
||
window.themeUseMermaid = JSON.parse("{ \"securityLevel\": \"loose\" }");
|
||
</script>
|
||
<script>window.noZensmooth = true;</script>
|
||
<script src="./js/swagger-ui/swagger-ui-bundle.js?1684361616" defer></script>
|
||
<script src="./js/swagger-ui/swagger-ui-standalone-preset.js?1684361616" defer></script>
|
||
<script>
|
||
window.themeUseOpenapi = { css: "/js/swagger-ui/swagger-ui.css?1684361616", assetsBuster: 1684361616 };
|
||
</script>
|
||
<script src="./js/theme.js?1684361616" defer></script>
|
||
</body>
|
||
</html>
|