nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 15:57:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
hugo-theme-relearn/pir/cont/markdown/index.print.html
McShelby 0c703be858 deploy: 13b4513688
2024-01-21 13:20:19 +00:00

784 lines
60 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="art-pir" dir="rtl">
<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.121.2">
<meta name="generator" content="Relearn 5.23.2+tip">
<meta name="description" content="Documentation for Hugo Relearn Theme">
<meta name="author" content="Sören Weber">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png">
<meta name="twitter:title" content="Marrrkdown rules :: Cap&#39;n Hugo Relearrrn Theme">
<meta name="twitter:description" content="Let&rsquo;s face it: Writ&#39;n rrrambl&#39;n fer th&#39; web be tiresome. WYSIWYG editors help alleviate this task, but they generally result &#39;n horr&#39;ble code, or worse yet, ugly web planks.
Marrrkdown be a better way t&#39; write HTML, without all th&#39; complexities an&#39; ugliness that usually accompanies it.
Some o&#39; th&#39; key benefits be:
Marrrkdown be simple t&#39; learn, wit&#39; minimal extra characters so it&rsquo;s also quicker t&#39; write rrrambl&#39;n. Less chance o&#39; errors when writ&#39;n &#39;n Marrrkdown.">
<meta property="og:title" content="Marrrkdown rules :: Cap&#39;n Hugo Relearrrn Theme">
<meta property="og:description" content="Let&rsquo;s face it: Writ&#39;n rrrambl&#39;n fer th&#39; web be tiresome. WYSIWYG editors help alleviate this task, but they generally result &#39;n horr&#39;ble code, or worse yet, ugly web planks.
Marrrkdown be a better way t&#39; write HTML, without all th&#39; complexities an&#39; ugliness that usually accompanies it.
Some o&#39; th&#39; key benefits be:
Marrrkdown be simple t&#39; learn, wit&#39; minimal extra characters so it&rsquo;s also quicker t&#39; write rrrambl&#39;n. Less chance o&#39; errors when writ&#39;n &#39;n Marrrkdown.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://McShelby.github.io/hugo-theme-relearn/pir/cont/markdown/index.html">
<meta property="og:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png">
<meta property="article:section" content="Rambl&#39;n :: Cap&#39;n Hugo Relearrrn Theme">
<meta property="og:site_name" content="Cap&#39;n Hugo Relearrrn Theme">
<title>Marrrkdown rules :: Cap&#39;n Hugo Relearrrn Theme</title>
<link href="https://McShelby.github.io/hugo-theme-relearn/cont/markdown/index.html" rel="alternate" hreflang="x-default">
<link href="https://McShelby.github.io/hugo-theme-relearn/cont/markdown/index.html" rel="alternate" hreflang="en">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/cont/markdown/index.html" rel="alternate" hreflang="art-pir">
<link href="https://McShelby.github.io/hugo-theme-relearn/pir/cont/markdown/index.html" rel="canonical" type="text/html" title="Marrrkdown rules :: Cap&#39;n Hugo Relearrrn Theme">
<link href="../../../pir/cont/markdown/index.xml" rel="alternate" type="application/rss+xml" title="Marrrkdown rules :: Cap&#39;n Hugo Relearrrn Theme">
<link href="../../../images/logo.svg?1705843213" 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?1705843216" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fontawesome-all.min.css?1705843216" rel="stylesheet"></noscript>
<link href="../../../css/nucleus.css?1705843216" rel="stylesheet">
<link href="../../../css/auto-complete.css?1705843216" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/auto-complete.css?1705843216" rel="stylesheet"></noscript>
<link href="../../../css/perfect-scrollbar.min.css?1705843216" rel="stylesheet">
<link href="../../../css/fonts.css?1705843216" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../../css/fonts.css?1705843216" rel="stylesheet"></noscript>
<link href="../../../css/theme.css?1705843216" rel="stylesheet">
<link href="../../../css/theme-relearn-auto.css?1705843216" rel="stylesheet" id="R-variant-style">
<link href="../../../css/chroma-relearn-auto.css?1705843216" rel="stylesheet" id="R-variant-chroma-style">
<link href="../../../css/variant.css?1705843216" rel="stylesheet">
<link href="../../../css/print.css?1705843216" rel="stylesheet" media="print">
<link href="../../../css/format-print.css?1705843216" rel="stylesheet">
<link href="../../../css/ie.css?1705843216" rel="stylesheet">
<script src="../../../js/url.js?1705843216"></script>
<script src="../../../js/variant.js?1705843216"></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(/\/$/, '');
window.relearn = window.relearn || {};
window.relearn.baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
// variant stuff
window.relearn.themeVariantModifier='';
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
// translations
window.T_Copy_to_clipboard = `Copy t' clipboard`;
window.T_Copied_to_clipboard = `Copied t' clipboard!`;
window.T_Copy_link_to_clipboard = `Copy link t' clipboard`;
window.T_Link_copied_to_clipboard = `Copied link t' clipboard!`;
window.T_Reset_view = `Rrreset view`;
window.T_View_reset = `View rrreset!`;
window.T_No_results_found = `No rrresults found fer "{0}"`;
window.T_N_results_found = `{1} rrresults found fer "{0}"`;
</script>
<style>
#R-body img.bg-white {
background-color: white;
}
</style>
</head>
<body class="mobile-support print disableInlineCopyToClipboard" data-url="../../../pir/cont/markdown/index.html">
<div id="R-body" class="default-animation">
<div id="R-body-overlay"></div>
<nav id="R-topbar">
<div class="topbar-wrapper">
<div class="topbar-sidebar-divider"></div>
<div class="topbar-area topbar-area-start" data-area="start">
<div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide"><button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL&#43;ALT&#43;n)"><i class="fa-fw fas fa-bars"></i></button>
</div>
</div>
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../../pir/cont/index.html"><span itemprop="name">Rambl&#39;n</span></a><meta itemprop="position" content="1">&nbsp;>&nbsp;</li><li
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Marrrkdown rules</span><meta itemprop="position" content="2"></li>
</ol>
<div class="topbar-area topbar-area-end" data-area="end">
</div>
</div>
</nav>
<div id="R-main-overlay"></div>
<main id="R-body-inner" class="highlightable default" tabindex="-1">
<div class="flex-block-wrapper">
<article class="default">
<header class="headline">
<div class=" taxonomy-tags term-list cstyle tags" title="Tag-a-taggs" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
<ul>
<li><a class="term-link" href="../../../pir/tags/content/index.html">Content</a></li>
</ul>
</div>
</header>
<h1 id="marrrkdown-rules">Marrrkdown rules</h1>
<p>Let&rsquo;s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.</p>
<p><strong>Marrrkdown</strong> be a better way t' write <strong>HTML</strong>, without all th' complexities an' ugliness that usually accompanies it.</p>
<p>Some o' th' key benefits be:</p>
<ol>
<li>Marrrkdown be simple t' learn, wit' minimal extra characters so it&rsquo;s also quicker t' write rrrambl'n.</li>
<li>Less chance o' errors when writ'n 'n Marrrkdown.</li>
<li>Produces valid HTML output.</li>
<li>Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship.</li>
<li>Write 'n any text editor or Marrrkdown applicat'n ye like.</li>
<li>Marrrkdown be a joy t' use!</li>
</ol>
<p>John Gruber, th' author o' Marrrkdown, puts it like this:</p>
<blockquote>
<p>Th' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email.
<cite>John Gruber</cite></p>
</blockquote>
<p>Without further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:</p>
<div class="box notices cstyle tip">
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Smarrrt Arrrse</div>
<div class="box-content">
<p><i class="fa-fw fas fa-bookmark"></i> Bookmark this plank an' th' <a href="https://commonmark.org/help/" target="_blank">official Commonmark reference</a> fer easy future reference!</p>
</div>
</div>
<h2 id="paragraphs">Paragraphs</h2>
<p>In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.</p>
<p>Any text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.</p>
<div class="wrap-code 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">Head'ns</h2>
<p>A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from <code>h1</code> through <code>h6</code> be constructed wit' a <code>#</code> fer each level.</p>
<p>In Hugo ye usually don&rsquo;t use <code>h1</code> as this be generated by yer theme an' ye should only have one such element 'n a document.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="gh"># h1 Head'n
</span></span></span><span class="line"><span class="cl"><span class="gh"></span>
</span></span><span class="line"><span class="cl"><span class="gu">## h2 Head'n
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
</span></span><span class="line"><span class="cl"><span class="gu">### h3 Head'n
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
</span></span><span class="line"><span class="cl"><span class="gu">#### h4 Head'n
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
</span></span><span class="line"><span class="cl"><span class="gu">##### h5 Head'n
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
</span></span><span class="line"><span class="cl">###### h6 Head'n</span></span></code></pre></div>
<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 Head'n</h1>
<h2 id="h2-heading">h2 Head'n</h2>
<h3 id="h3-heading">h3 Head'n</h3>
<h4 id="h4-heading">h4 Head'n</h4>
<h5 id="h5-heading">h5 Head'n</h5>
<h6 id="h6-heading">h6 Head'n</h6>
</div>
</div>
<h2 id="horizontal-rules">Horizontal Rules</h2>
<p>T' further structure yer rrrambl'n ye can add horizontal rules. They create a &ldquo;thematic break&rdquo; between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes <code>---</code>.</p>
<div class="wrap-code 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>Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks <code>**</code>.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">I am rendered wit' **bold 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>I am rendered wit' <strong>bold text</strong></p>
</div>
</div>
<h3 id="italics">Italics</h3>
<p>Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores <code>_</code>.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">I am rendered wit' _italicized 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>I am rendered wit' <em>italicized text</em></p>
</div>
</div>
<h3 id="strikethrough">Strikethrough</h3>
<p>In GFM (GitHub Flavored Markdown) ye can do strikethroughs by enclos'n text wit' two tildes <code>~~</code>.</p>
<div class="wrap-code 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 substitut'n</h2>
<p>This Marrrkdown dialect supports an extension t' combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Do'ble quotes <span class="sb">`&#34;`</span> an' single quotes <span class="sb">`&#39;`</span> o' enclosed text be replaced by <span class="ge">**</span>&#34;do'ble curly quotes&#34;** an' <span class="ge">**</span>&#39;single curly quotes&#39;**.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">Do'ble dashes <span class="sb">`--`</span> an' triple dashes <span class="sb">`---`</span> be replaced by en-dash <span class="ge">**</span>--** an' em-dash <span class="ge">**</span>---** entities.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">Do'ble arrows point'n left <span class="sb">`&lt;&lt;`</span> or right <span class="sb">`&gt;&gt;`</span> be replaced by arrow <span class="ge">**</span><span class="err">&lt;&lt;</span>** an' <span class="ge">**</span>&gt;&gt;** entities.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">Three consecutive dots <span class="sb">`...`</span> be replaced by an ellipsis <span class="ge">**</span>...** entity.</span></span></code></pre></div>
<div class="box notices cstyle secondary">
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
<div class="box-content">
<p>Do'ble quotes <code>&quot;</code> an' single quotes <code>'</code> o' enclosed text be replaced by <strong>&ldquo;do'ble curly quotes&rdquo;</strong> an' <strong>&lsquo;single curly quotes&rsquo;</strong>.</p>
<p>Do'ble dashes <code>--</code> an' triple dashes <code>---</code> be replaced by en-dash <strong>&ndash;</strong> an' em-dash <strong>&mdash;</strong> entities.</p>
<p>Do'ble arrows point'n left <code>&lt;&lt;</code> or right <code>&gt;&gt;</code> be replaced by arrow <strong>&laquo;</strong> an' <strong>&raquo;</strong> entities.</p>
<p>Three consecutive dots <code>...</code> be replaced by an ellipsis <strong>&hellip;</strong> entity.</p>
</div>
</div>
<h2 id="lists">Lists</h2>
<h3 id="unordered">Unordered</h3>
<p>Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.</p>
<p>It be poss'ble t' nest lists by indent'n an item fer th' next sublevel.</p>
<p>Ye may use any o' <code>-</code>, <code>*</code> or <code>+</code> t' denote bullets fer each list item but should not switch between those symbols inside one whole list.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">-</span> Lorem ipsum dolor sit amet
</span></span><span class="line"><span class="cl"><span class="k">-</span> Consectetur adipisc'n elit
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Vestibulum laoreet porttitor sem
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Ac tristique libero volutpat at
</span></span><span class="line"><span class="cl"><span class="k">-</span> Nulla volutpat aliquam velit
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Phasellus iaculis neque
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Purus sodales ultricies
</span></span><span class="line"><span class="cl">- Faucibus porta lacus fringilla vel</span></span></code></pre></div>
<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 adipisc'n elit
<ul>
<li>Vestibulum laoreet porttitor sem</li>
<li>Ac tristique libero volutpat at</li>
</ul>
</li>
<li>Nulla volutpat aliquam velit
<ul>
<li>Phasellus iaculis neque</li>
<li>Purus sodales ultricies</li>
</ul>
</li>
<li>Faucibus porta lacus fringilla vel</li>
</ul>
</div>
</div>
<h3 id="ordered">Ordered</h3>
<p>Ye can create a list o' items 'n which th' order o' items does explicitly matter.</p>
<p>It be poss'ble t' nest lists by indent'n an item fer th' next sublevel.</p>
<p>Marrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.</p>
<div class="wrap-code 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 adipisc'n elit
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Integer molestie lorem at massa
</span></span><span class="line"><span class="cl"> <span class="k">7.</span> Facilisis 'n pretium nisl aliquet
</span></span><span class="line"><span class="cl"><span class="k">99.</span> Nulla volutpat aliquam velit
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Faucibus porta lacus fringilla vel
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Aenean sit amet erat nunc
</span></span><span class="line"><span class="cl">17. Eget porttitor lorem</span></span></code></pre></div>
<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 adipisc'n elit
<ol>
<li>Integer molestie lorem at massa</li>
<li>Facilisis 'n pretium nisl aliquet</li>
</ol>
</li>
<li>Nulla volutpat aliquam velit
<ol>
<li>Faucibus porta lacus fringilla vel</li>
<li>Aenean sit amet erat nunc</li>
</ol>
</li>
<li>Eget porttitor lorem</li>
</ol>
</div>
</div>
<h3 id="tasks">Tasks</h3>
<p>In GFM (GitHub Flavored Markdown) ye can add task lists result'n 'n checked or unchecked non-click'ble items</p>
<div class="wrap-code 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"> - [ ] 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">Definit'ns</h3>
<p>This Marrrkdown dialect supports an extension t' add definit'n lists. Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.</p>
<p>A definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.</p>
<p>If ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Apple
</span></span><span class="line"><span class="cl">: Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae.
</span></span><span class="line"><span class="cl">: An American computer company.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">Orange
</span></span><span class="line"><span class="cl">: Th' fruit o' an evergreen tree o' th' genus Citrus.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> Ye can make juice out o' it.
</span></span><span class="line"><span class="cl">: A telecommunicat'n company.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> Ye can&#39;t make juice out o' it.</span></span></code></pre></div>
<div class="box notices cstyle secondary">
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
<div class="box-content">
<dl>
<dt>Apple</dt>
<dd>Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae.</dd>
<dd>An American computer company.</dd>
<dt>Orange</dt>
<dd>Th' fruit o' an evergreen tree o' th' genus Citrus.
<p>Ye can make juice out o' it.</p>
</dd>
<dd>A telecommunicat'n company.
<p>Ye can&rsquo;t make juice out o' it.</p>
</dd>
</dl>
</div>
</div>
<h2 id="code">Code</h2>
<h3 id="inline-code">Inline Code</h3>
<p>Inline snippets o' code can be wrapped wit' backticks <code>`</code>.</p>
<div class="wrap-code 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">`&lt;div&gt;&lt;/div&gt;`</span> be marked as code.</span></span></code></pre></div>
<div class="box notices cstyle secondary">
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
<div class="box-content">
<p>In this example, <code>&lt;div&gt;&lt;/div&gt;</code> be marked as code.</p>
</div>
</div>
<h3 id="indented-code-block">Indented Code Block</h3>
<p>A simple code block can be generated by indent'n several lines o' code by at least two spaces.</p>
<div class="wrap-code 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 o' code
</span></span><span class="line"><span class="cl"> line 2 o' code
</span></span><span class="line"><span class="cl"> line 3 o' code</span></span></code></pre></div>
<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 o' code
line 2 o' code
line 3 o' code
</code></pre>
</div>
</div>
<h3 id="fenced-code-block">Fenced Code Block</h3>
<p>If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks <code>```</code> a so called fence.</p>
<p>In GFM (GitHub Flavored Markdown) ye can also add a language specifier directly after th' open'n fence, <code>```js</code>, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.</p>
<p>See <a href="../../../shortcodes/highlight/index.html">Code Highlight'n</a> fer additional documentat'n.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```js
</span></span><span class="line"><span class="cl">grunt.initConfig({
</span></span><span class="line"><span class="cl"> assemble: {
</span></span><span class="line"><span class="cl"> opt'ns: {
</span></span><span class="line"><span class="cl"> assets: &#39;docs/assets&#39;,
</span></span><span class="line"><span class="cl"> data: &#39;src/data/*.{json,yml}&#39;,
</span></span><span class="line"><span class="cl"> helpers: &#39;src/custom-helpers.js&#39;,
</span></span><span class="line"><span class="cl"> partials: [&#39;src/partials/**/*.{hbs,md}&#39;]
</span></span><span class="line"><span class="cl"> },
</span></span><span class="line"><span class="cl"> planks: {
</span></span><span class="line"><span class="cl"> opt'ns: {
</span></span><span class="line"><span class="cl"> layout: &#39;default.hbs&#39;
</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"> &#39;./&#39;: [&#39;src/templates/pages/index.hbs&#39;]
</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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="nx">grunt</span><span class="p">.</span><span class="nx">initConfig</span><span class="p">({</span>
</span></span><span class="line"><span class="cl"> <span class="nx">assemble</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">opt'ns</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">assets</span><span class="o">:</span> <span class="s1">&#39;docs/assets&#39;</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">&#39;src/data/*.{json,yml}&#39;</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">&#39;src/custom-helpers.js&#39;</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">&#39;src/partials/**/*.{hbs,md}&#39;</span><span class="p">]</span>
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
</span></span><span class="line"><span class="cl"> <span class="nx">planks</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">opt'ns</span><span class="o">:</span> <span class="p">{</span>
</span></span><span class="line"><span class="cl"> <span class="nx">layout</span><span class="o">:</span> <span class="s1">&#39;default.hbs&#39;</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">&#39;./&#39;</span><span class="o">:</span> <span class="p">[</span><span class="s1">&#39;src/templates/pages/index.hbs&#39;</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) ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">| Opt'n | Descript'n |
</span></span><span class="line"><span class="cl">|--------|-------------|
</span></span><span class="line"><span class="cl">| data | path t' data files t' supply th' data that will be passed into templates. |
</span></span><span class="line"><span class="cl">| engine | engine t' be used fer process'n templates. Handlebars be th' default. |
</span></span><span class="line"><span class="cl">| ext | extension t' be used fer dest files. |</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>Opt'n</th>
<th>Descript'n</th>
</tr>
</thead>
<tbody>
<tr>
<td>data</td>
<td>path t' data files t' supply th' data that will be passed into templates.</td>
</tr>
<tr>
<td>engine</td>
<td>engine t' be used fer process'n templates. Handlebars be th' default.</td>
</tr>
<tr>
<td>ext</td>
<td>extension t' be used fer dest files.</td>
</tr>
</tbody>
</table>
</div>
</div>
<h3 id="aligned-columns">Aligned Columns</h3>
<p>Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">| Opt'n | Number | Descript'n |
</span></span><span class="line"><span class="cl">|-------:|:------:|:------------|
</span></span><span class="line"><span class="cl">| data | 1 | path t' data files t' supply th' data that will be passed into templates. |
</span></span><span class="line"><span class="cl">| engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. |
</span></span><span class="line"><span class="cl">| ext | 3 | extension t' be used fer dest files. |</span></span></code></pre></div>
<div class="box notices cstyle secondary">
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
<div class="box-content">
<table>
<thead>
<tr>
<th style="text-align:right">Opt'n</th>
<th style="text-align:center">Number</th>
<th style="text-align:left">Descript'n</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:right">data</td>
<td style="text-align:center">1</td>
<td style="text-align:left">path t' data files t' supply th' data that will be passed into templates.</td>
</tr>
<tr>
<td style="text-align:right">engine</td>
<td style="text-align:center">2</td>
<td style="text-align:left">engine t' be used fer process'n templates. Handlebars be th' default.</td>
</tr>
<tr>
<td style="text-align:right">ext</td>
<td style="text-align:center">3</td>
<td style="text-align:left">extension t' be used fer dest files.</td>
</tr>
</tbody>
</table>
</div>
</div>
<h2 id="blockquotes">Blockquotes</h2>
<p>For quot'n blocks o' rrrambl'n from another source within yer document add <code>&gt;</code> before any text ye want t' quote.</p>
<p>Blockquotes can also be nested.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">&gt; </span><span class="ge">Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">&gt;
</span></span></span><span class="line"><span class="cl"><span class="k"></span><span class="ge">&gt; &gt; Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.
</span></span></span><span class="line"><span class="cl"><span class="ge"></span>&gt;
</span></span><span class="line"><span class="cl">&gt; Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</span></span></code></pre></div>
<div class="box notices cstyle secondary">
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
<div class="box-content">
<blockquote>
<p>Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.</p>
<blockquote>
<p>Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.</p>
</blockquote>
<p>Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</p>
</blockquote>
</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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">This be a link t' https://example.com.</span></span></code></pre></div>
<div class="box notices cstyle secondary">
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
<div class="box-content">
<p>This be a link t' <a href="https://example.com" target="_blank">https://example.com</a>.</p>
</div>
</div>
<h3 id="basic-link">Basic Link</h3>
<p>Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.</p>
<div class="wrap-code 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 wit' Tooltip</h3>
<p>For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.</p>
<div class="wrap-code 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/ &#34;Visit Upstage!&#34;</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 fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.</p>
<div class="wrap-code 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 &#34;Go t' example domain&#34;</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 t' example domain" target="_blank">Example</a></p>
</div>
</div>
<h3 id="footnotes">Footnotes</h3>
<p>Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.</p>
<p>Usually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.</p>
<p>Footnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.</p>
<div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">That&#39;s some text wit' a footnote[^1]
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">[^1]: An' that&#39;s th' footnote.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl">That&#39;s some more text wit' 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"> Anyth'n o' interest goes here.
</span></span><span class="line"><span class="cl">
</span></span><span class="line"><span class="cl"> Blue light glows blue.</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&rsquo;s some text wit' a footnote<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></p>
<p>That&rsquo;s some more text wit' a footnote.<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></p>
<div class="footnotes" role="doc-endnotes">
<hr>
<ol>
<li id="fn:1">
<p>An' that&rsquo;s th' footnote.&#160;<a href="#fnref:1" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p>
</li>
<li id="fn:2">
<p>Anyth'n o' interest goes here.</p>
<p>Blue light glows blue.&#160;<a href="#fnref:2" class="footnote-backref" role="doc-backlink">&#x21a9;&#xfe0e;</a></p>
</li>
</ol>
</div>
</div>
</div>
<h2 id="images">Images</h2>
<h3 id="basic-images">Basic Images</h3>
<p>Images have a similar rules t' links but include a preced'n exclamat'n mark.</p>
<div class="wrap-code 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="#R-image-300db853924e1c9e1513f9be7de3dc77" class="lightbox-link"><img src="https://octodex.github.com/images/spocktocat.png?width=20vw" alt="Spock" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-300db853924e1c9e1513f9be7de3dc77"><img src="https://octodex.github.com/images/spocktocat.png?width=20vw" alt="Spock" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
</div>
</div>
<h3 id="image-with-tooltip">Image wit' Tooltip</h3>
<p>Like links, images can also be given a tooltip.</p>
<div class="wrap-code 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 &#34;Jean Luc Picard&#34;</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="#R-image-3d650a36b14fbf6aa6c9392cbea2458a" class="lightbox-link"><img src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt="Picard" title="Jean Luc Picard" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-3d650a36b14fbf6aa6c9392cbea2458a"><img src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt="Picard" title="Jean Luc Picard" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
</div>
</div>
<h3 id="image-references">Image References</h3>
<p>Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.</p>
<div class="wrap-code 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 &#34;Geordi La Forge&#34;</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="#R-image-adc5b7b7f31dfcec4f0ae3b519436aac" class="lightbox-link"><img src="https://octodex.github.com/images/trekkie.jpg?width=20vw" alt="La Forge" title="Geordi La Forge" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-adc5b7b7f31dfcec4f0ae3b519436aac"><img src="https://octodex.github.com/images/trekkie.jpg?width=20vw" alt="La Forge" title="Geordi La Forge" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
</div>
</div>
<h3 id="image-effects">Image Effects</h3>
<p>This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. Th' default <a href="../../../cont/imageeffects/index.html">behavior be configur'ble</a> thru yer <code>hugo.toml</code> or frontmatter parameter.</p>
<h4 id="resizing">Resiz'n</h4>
<p>Add query parameter <code>width</code> and/or <code>height</code> t' th' link image t' resize th' image. Values be CSS values (default be <code>auto</code>).</p>
<div class="wrap-code 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="#R-image-3ee39719ee97aa3d7c00026ba39b3b50" class="lightbox-link"><img src="https://octodex.github.com/images/minion.png?width=20vw" alt="Minion" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-3ee39719ee97aa3d7c00026ba39b3b50"><img src="https://octodex.github.com/images/minion.png?width=20vw" alt="Minion" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
</div>
</div>
<div class="wrap-code 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="#R-image-9648b2c070a1b3628abc90811fdea44e" class="lightbox-link"><img src="https://octodex.github.com/images/minion.png?height=50px" alt="Minion" class="figure-image bg-white border lightbox noshadow" style="height: 50px; width: auto;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-9648b2c070a1b3628abc90811fdea44e"><img src="https://octodex.github.com/images/minion.png?height=50px" alt="Minion" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
</div>
</div>
<div class="wrap-code 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&amp;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="#R-image-abd952658ec9bd24d9fb70d50686d411" class="lightbox-link"><img src="https://octodex.github.com/images/minion.png?height=50px&amp;width=40vw" alt="Minion" class="figure-image bg-white border lightbox noshadow" style="height: 50px; width: 40vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-abd952658ec9bd24d9fb70d50686d411"><img src="https://octodex.github.com/images/minion.png?height=50px&amp;width=40vw" alt="Minion" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p>
</div>
</div>
<h4 id="css-classes">CSS Classes</h4>
<p>Add a query parameter <code>classes</code> t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.</p>
<h5 id="shadow">Shadow</h5>
<div class="wrap-code 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="#R-image-72d1d89b669143744cba66acbf05aedc" class="lightbox-link"><img src="https://octodex.github.com/images/spidertocat.png?width=20vw&amp;classes=shadow,noborder" alt="Spidertocat" class="figure-image bg-white border lightbox noborder shadow" style="height: auto; width: 20vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-72d1d89b669143744cba66acbf05aedc"><img src="https://octodex.github.com/images/spidertocat.png?width=20vw&amp;classes=shadow,noborder" alt="Spidertocat" class="lightbox-image bg-white border lightbox noborder shadow" loading="lazy"></a></p>
</div>
</div>
<h5 id="border">Border</h5>
<div class="wrap-code 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="#R-image-b561cb6fa6a8989907e029f43e7307ae" class="lightbox-link"><img src="https://octodex.github.com/images/droctocat.png?width=20vw&amp;classes=border,noshadow" alt="DrOctocat" class="figure-image bg-white border lightbox noshadow noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-b561cb6fa6a8989907e029f43e7307ae"><img src="https://octodex.github.com/images/droctocat.png?width=20vw&amp;classes=border,noshadow" alt="DrOctocat" class="lightbox-image bg-white border lightbox noshadow noshadow" loading="lazy"></a></p>
</div>
</div>
<h5 id="left">Left</h5>
<div class="wrap-code 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="#R-image-15ebca2b33a3af6be95806ee72b824be" class="lightbox-link"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&amp;classes=left" alt="Supertocat" class="figure-image bg-white border left lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-15ebca2b33a3af6be95806ee72b824be"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&amp;classes=left" alt="Supertocat" class="lightbox-image bg-white border left lightbox noshadow" loading="lazy"></a></p>
</div>
</div>
<h5 id="right">Right</h5>
<div class="wrap-code 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="#R-image-14f49cecf094409c7b841c41c911dbe1" class="lightbox-link"><img src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&amp;classes=right" alt="Riddlocat" class="figure-image bg-white border lightbox right noshadow" style="height: auto; width: 20vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-14f49cecf094409c7b841c41c911dbe1"><img src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&amp;classes=right" alt="Riddlocat" class="lightbox-image bg-white border lightbox right noshadow" loading="lazy"></a></p>
</div>
</div>
<h5 id="inline">Inline</h5>
<div class="wrap-code 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="#R-image-3b4fe893cfeba598031635aacd5c9d4e" class="lightbox-link"><img src="https://octodex.github.com/images/spidertocat.png?width=10vw&amp;classes=inline" alt="Spidertocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-3b4fe893cfeba598031635aacd5c9d4e"><img src="https://octodex.github.com/images/spidertocat.png?width=10vw&amp;classes=inline" alt="Spidertocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a>
<a href="#R-image-23af55bb51d780607d5b114c37cd80cd" class="lightbox-link"><img src="https://octodex.github.com/images/droctocat.png?width=10vw&amp;classes=inline" alt="DrOctocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-23af55bb51d780607d5b114c37cd80cd"><img src="https://octodex.github.com/images/droctocat.png?width=10vw&amp;classes=inline" alt="DrOctocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a>
<a href="#R-image-ea485fa8384e101b8380746b28044793" class="lightbox-link"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&amp;classes=inline" alt="Supertocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-ea485fa8384e101b8380746b28044793"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&amp;classes=inline" alt="Supertocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a>
<a href="#R-image-c573aea058f9ab1fb9e73880d7eb81f8" class="lightbox-link"><img src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&amp;classes=inline" alt="Riddlocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-c573aea058f9ab1fb9e73880d7eb81f8"><img src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&amp;classes=inline" alt="Riddlocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a></p>
</div>
</div>
<h5 id="combination">Combinat'n</h5>
<div class="wrap-code 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="#R-image-ca5fbc8d50fdda4a2149b67fcce9593d" class="lightbox-link"><img src="https://octodex.github.com/images/xtocat.jpg?width=20vw&amp;classes=shadow,border,left" alt="X-tocat" class="figure-image bg-white border left lightbox shadow" style="height: auto; width: 20vw;" loading="lazy"></a>
<a href="javascript:history.back();" class="lightbox-back" id="R-image-ca5fbc8d50fdda4a2149b67fcce9593d"><img src="https://octodex.github.com/images/xtocat.jpg?width=20vw&amp;classes=shadow,border,left" alt="X-tocat" class="lightbox-image bg-white border left lightbox shadow" loading="lazy"></a></p>
</div>
</div>
<h4 id="lightbox">Lightbox</h4>
<p>Add th' query parameter <code>lightbox=false</code> t' th' image link t' dis'ble th' lightbox.</p>
<div class="wrap-code 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&amp;lightbox=false" alt="Homercat" class="figure-image bg-white border nolightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></p>
</div>
</div>
<div class="box notices cstyle note">
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Avast</div>
<div class="box-content">
<p>If ye want t' wrap an image 'n a link an' <code>lightbox=true</code> be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:</p>
<div class="wrap-code 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>)](https://octodex.github.com/#homercat)</span></span></code></pre></div><p><a href="https://octodex.github.com/#homercat" target="_blank"><img src="https://octodex.github.com/images/homercat.png?width=20vw&amp;lightbox=false" alt="Homercat" class="figure-image bg-white border nolightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a></p>
</div>
</div>
<footer class="footline">
</footer>
</article>
</div>
</main>
</div>
<script src="../../../js/clipboard.min.js?1705843216" defer></script>
<script src="../../../js/perfect-scrollbar.min.js?1705843216" defer></script>
<script src="../../../js/theme.js?1705843216" defer></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink