mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-24 08:13:05 +00:00
249 lines
18 KiB
HTML
249 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="pir" 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.106.0">
|
|
<meta name="generator" content="Relearn 5.6.3+tip">
|
|
<meta name="description" content="Documentation for Hugo Relearn Theme">
|
|
<meta name="author" content="Sören Weber">
|
|
<title>Expand :: Cap'n Hugo Relearrrn Theme</title>
|
|
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/expand/index.html" rel="canonical" type="text/html" title="Expand :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="../../../pir/shortcodes/expand/index.xml" rel="alternate" type="application/rss+xml" title="Expand :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="../../../images/logo.svg?1668870406" 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?1668870407" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fontawesome-all.min.css?1668870407" rel="stylesheet"></noscript>
|
|
<link href="../../../css/featherlight.min.css?1668870407" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/featherlight.min.css?1668870407" rel="stylesheet"></noscript>
|
|
<link href="../../../css/auto-complete.css?1668870407" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/auto-complete.css?1668870407" rel="stylesheet"></noscript>
|
|
<link href="../../../css/perfect-scrollbar.min.css?1668870407" rel="stylesheet">
|
|
<link href="../../../css/nucleus.css?1668870407" rel="stylesheet">
|
|
<link href="../../../css/fonts.css?1668870407" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fonts.css?1668870407" rel="stylesheet"></noscript>
|
|
<link href="../../../css/theme.css?1668870407" rel="stylesheet">
|
|
<link href="../../../css/theme-relearn-light.css?1668870407" rel="stylesheet" id="variant-style">
|
|
<link href="../../../css/ie.css?1668870407" rel="stylesheet">
|
|
<link href="../../../css/variant.css?1668870407" rel="stylesheet">
|
|
<link href="../../../css/print.css?1668870407" rel="stylesheet" media="print">
|
|
<link href="../../../css/format-print.css?1668870407" rel="stylesheet">
|
|
<script src="../../../js/url.js?1668870407"></script>
|
|
<script src="../../../js/variant.js?1668870407"></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="../../../pir/index.search.js";
|
|
var root_url="../../../";
|
|
var baseUri=root_url.replace(/\/$/, '');
|
|
// translations
|
|
window.T_Copy_to_clipboard = 'Copy t\u0027 clipboard';
|
|
window.T_Copied_to_clipboard = 'Copied t\u0027 clipboard!';
|
|
window.T_Copy_link_to_clipboard = 'Copy link t\u0027 clipboard';
|
|
window.T_Link_copied_to_clipboard = 'Copied link t\u0027 clipboard!';
|
|
window.T_No_results_found = 'No rrresults found fer \u0022{0}\u0022';
|
|
window.T_N_results_found = '{1} rrresults found fer \u0022{0}\u0022';
|
|
// some further base stuff
|
|
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
|
|
window.variants && variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
|
|
</script>
|
|
<script src="../../../js/jquery.min.js?1668870407" defer></script>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../../pir/shortcodes/expand/index.html">
|
|
<div id="body" class="default-animation">
|
|
<div id="sidebar-overlay"></div>
|
|
<div id="toc-overlay"></div>
|
|
<nav id="topbar" class="highlightable" dir="ltr">
|
|
<div>
|
|
<div id="breadcrumbs">
|
|
<span id="sidebar-toggle-span">
|
|
<a href="#" id="sidebar-toggle" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a>
|
|
</span>
|
|
<ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList">
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../../pir/index.html"><span itemprop="name">Cap'n Hugo Relearrrn Theme</span></a><meta itemprop="position" content="1"> > </li>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../../pir/shortcodes/index.html"><span itemprop="name">Shorrrtcodes</span></a><meta itemprop="position" content="2"> > </li>
|
|
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Expand</span><meta itemprop="position" content="3"></li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<main id="body-inner" class="highlightable default" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<div id="head-tags">
|
|
</div>
|
|
<article class="default">
|
|
<h1 id="expand">Expand</h1>
|
|
|
|
|
|
<div class="box notices cstyle warning">
|
|
<div class="box-label"><i class="fa-fw fas fa-skull-crossbones"></i> Arrr! Pirrrates</div>
|
|
<div class="box-content">
|
|
<p>Fello' pirrates, be awarrre <b>some stuff may not work</b> fer us in this trrranslat'n. Like <b>table of rrramblings</b>, see'ng <b>Merrrmaids</b>, do'ng <b>math or chemistrrry</b> and stuff.</p> </div>
|
|
</div>
|
|
|
|
<p>Th' <code>expand</code> shorrrtcode displays an expandable/collaps'ble section o' text.</p>
|
|
|
|
<div class="expand">
|
|
<a class="expand-label" onclick="$t=$(this); if($t.parent('.expand-expanded.expand-marked').length){ $t.next().css('display','none') }else if($t.parent('.expand-marked').length){ $t.next().css('display','block') }else{ $t.next('.expand-content').slideToggle(100); } $t.parent().toggleClass('expand-expanded');">
|
|
<i class="fas fa-chevron-down"></i>
|
|
<i class="fas fa-chevron-left expand-rtl direction-ltr"></i>
|
|
<i class="fas fa-chevron-right expand-ltr direction-ltr"></i>
|
|
Expand me...
|
|
</a>
|
|
<div class="expand-content" style="display: none;">
|
|
Thank ye!
|
|
</div>
|
|
</div>
|
|
<h2 id="usage">Usage</h2>
|
|
<p>While th' examples be us'n shorrrtcodes wit' named parameter ye be free t' use positional as well or also call this shorrrtcode from yer own partials.</p>
|
|
|
|
<div class="tab-panel">
|
|
<div class="tab-nav">
|
|
<button
|
|
data-tab-item="shortcode"
|
|
data-tab-group="shortcode-parameter"
|
|
class="tab-nav-button direction-ltr active"
|
|
onclick="switchTab('shortcode-parameter','shortcode')"
|
|
><span>shorrrtcode</span></button>
|
|
<button
|
|
data-tab-item="shortcode (positional)"
|
|
data-tab-group="shortcode-parameter"
|
|
class="tab-nav-button direction-ltr "
|
|
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
|
|
><span>shorrrtcode (positional)</span></button>
|
|
<button
|
|
data-tab-item="partial"
|
|
data-tab-group="shortcode-parameter"
|
|
class="tab-nav-button direction-ltr "
|
|
onclick="switchTab('shortcode-parameter','partial')"
|
|
><span>partial</span></button>
|
|
</div>
|
|
<div class="tab-content">
|
|
<div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item 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">ye</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span></code></pre></div>
|
|
</div>
|
|
<div data-tab-item="shortcode (positional)" data-tab-group="shortcode-parameter" class="tab-item ">
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">expand</span> <span class="s">"Expand me..."</span> <span class="o">%</span><span class="p">}}</span><span class="nx">Thank</span> <span class="nx">ye</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span></code></pre></div>
|
|
</div>
|
|
<div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item ">
|
|
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/expand.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"context"</span> <span class="p">.</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"title"</span> <span class="s">"Expand me..."</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"Thank ye!"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">)}}</span>
|
|
</span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="parameter">Parameter</h3>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align:left">Name</th>
|
|
<th style="text-align:left">Posit'n</th>
|
|
<th style="text-align:left">Default</th>
|
|
<th style="text-align:left">Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align:left"><strong>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 t' appear next t' th' expand/collapse ay'con.</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> th' rrrambl'n text will be initially shown as expanded.</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align:left"><em><strong><content></strong></em></td>
|
|
<td style="text-align:left"></td>
|
|
<td style="text-align:left"><em><empty></em></td>
|
|
<td style="text-align:left">Arbitrary text t' 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">ye</span> <span class="nx">did</span> <span class="nx">it</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span></code></pre></div>
|
|
<div class="expand">
|
|
<a class="expand-label" onclick="$t=$(this); if($t.parent('.expand-expanded.expand-marked').length){ $t.next().css('display','none') }else if($t.parent('.expand-marked').length){ $t.next().css('display','block') }else{ $t.next('.expand-content').slideToggle(100); } $t.parent().toggleClass('expand-expanded');">
|
|
<i class="fas fa-chevron-down"></i>
|
|
<i class="fas fa-chevron-left expand-rtl direction-ltr"></i>
|
|
<i class="fas fa-chevron-right expand-ltr direction-ltr"></i>
|
|
Expand me...
|
|
</a>
|
|
<div class="expand-content" style="display: none;">
|
|
Yes, ye 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">t'</span> <span class="nx">press</span> <span class="nx">ye</span><span class="p">!{{</span><span class="o">%</span> <span class="o">/</span><span class="nx">expand</span> <span class="o">%</span><span class="p">}}</span>
|
|
</span></span></code></pre></div>
|
|
<div class="expand expand-expanded">
|
|
<a class="expand-label" onclick="$t=$(this); if($t.parent('.expand-expanded.expand-marked').length){ $t.next().css('display','none') }else if($t.parent('.expand-marked').length){ $t.next().css('display','block') }else{ $t.next('.expand-content').slideToggle(100); } $t.parent().toggleClass('expand-expanded');">
|
|
<i class="fas fa-chevron-down"></i>
|
|
<i class="fas fa-chevron-left expand-rtl direction-ltr"></i>
|
|
<i class="fas fa-chevron-right expand-ltr direction-ltr"></i>
|
|
Expand me...
|
|
</a>
|
|
<div class="expand-content" style="display: block;">
|
|
No need t' press ye!
|
|
</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">Ye</span> <span class="nx">can</span> <span class="nx">add</span> <span class="nx">standard</span> <span class="nx">markdown</span> <span class="nx">rules</span><span class="p">:</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">multiple</span> <span class="nx">paragraphs</span>
|
|
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">bullet</span> <span class="nx">point</span> <span class="nx">lists</span>
|
|
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="nx">_emphasized_</span><span class="p">,</span> <span class="o">**</span><span class="nx">bold</span><span class="o">**</span> <span class="nx">an'</span> <span class="nx">even</span> <span class="o">**</span><span class="nx">_bold</span> <span class="nx">emphasized_</span><span class="o">**</span> <span class="nx">text</span>
|
|
</span></span><span class="line"><span class="cl"><span class="o">-</span> <span class="p">[</span><span class="nx">links</span><span class="p">](</span><span class="nx">https</span><span class="p">:</span><span class="c1">//example.com)
|
|
</span></span></span><span class="line"><span class="cl"><span class="c1"></span><span class="o">-</span> <span class="nx">etc</span><span class="p">.</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="s">```plaintext
|
|
</span></span></span><span class="line"><span class="cl"><span class="s">...and even source code
|
|
</span></span></span><span class="line"><span class="cl"><span class="s">```</span>
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"><span class="p">></span> <span class="nx">th'</span> <span class="nx">possibilities</span> <span class="nx">be</span> <span class="nf">endless</span> <span class="p">(</span><span class="nx">almost</span> <span class="o">-</span> <span class="nx">includ'n</span> <span class="nx">other</span> <span class="nx">shorrrtcodes</span> <span class="nx">may</span> <span class="nx">or</span> <span class="nx">may</span> <span class="nx">not</span> <span class="nx">work</span><span class="p">)</span>
|
|
</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">
|
|
<a class="expand-label" onclick="$t=$(this); if($t.parent('.expand-expanded.expand-marked').length){ $t.next().css('display','none') }else if($t.parent('.expand-marked').length){ $t.next().css('display','block') }else{ $t.next('.expand-content').slideToggle(100); } $t.parent().toggleClass('expand-expanded');">
|
|
<i class="fas fa-chevron-down"></i>
|
|
<i class="fas fa-chevron-left expand-rtl direction-ltr"></i>
|
|
<i class="fas fa-chevron-right expand-ltr direction-ltr"></i>
|
|
Show me almost endless possibilities
|
|
</a>
|
|
<div class="expand-content" style="display: none;">
|
|
<p>Ye can add standard markdown rules:</p>
|
|
<ul>
|
|
<li>multiple paragraphs</li>
|
|
<li>bullet point lists</li>
|
|
<li><em>emphasized</em>, <strong>bold</strong> an' even <strong><em>bold emphasized</em></strong> text</li>
|
|
<li><a href="https://example.com">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>th' possibilities be endless (almost - includ'n other shorrrtcodes may or may not work)</p>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="../../../js/clipboard.min.js?1668870407" defer></script>
|
|
<script src="../../../js/perfect-scrollbar.min.js?1668870407" defer></script>
|
|
<script src="../../../js/featherlight.min.js?1668870407" defer></script>
|
|
<script src="../../../js/theme.js?1668870407" defer></script>
|
|
</body>
|
|
</html>
|