mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-30 11:13:06 +00:00
1103 lines
84 KiB
HTML
1103 lines
84 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="art-x-pir" dir="rtl" itemscope itemtype="http://schema.org/Article">
|
|
<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.139.0">
|
|
<meta name="generator" content="Relearn 7.1.1+ab4197f3113afa9a7d17bed69dbef6c0e75a4921">
|
|
<meta name="description" content="Reference of CommonMark and Markdown extensions">
|
|
<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'n Hugo Relearrrn Theme">
|
|
<meta name="twitter:description" content="Reference of CommonMark and Markdown extensions">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/markdown/index.html">
|
|
<meta property="og:site_name" content="Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:title" content="Marrrkdown Rules :: Cap'n Hugo Relearrrn Theme">
|
|
<meta property="og:description" content="Reference of CommonMark and Markdown extensions">
|
|
<meta property="og:locale" content="art_x_pir">
|
|
<meta property="og:type" content="article">
|
|
<meta property="article:section" content="Rambl'n">
|
|
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="name" content="Marrrkdown Rules :: Cap'n Hugo Relearrrn Theme">
|
|
<meta itemprop="description" content="Reference of CommonMark and Markdown extensions">
|
|
<meta itemprop="wordCount" content="3093">
|
|
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="keywords" content="Howto,Reference">
|
|
<title>Marrrkdown Rules :: Cap'n Hugo Relearrrn Theme</title>
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown/index.html" rel="alternate" hreflang="x-default">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/authoring/markdown/index.html" rel="alternate" hreflang="en">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/markdown/index.html" rel="alternate" hreflang="art-x-pir">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/authoring/markdown/index.html" rel="canonical" type="text/html" title="Marrrkdown Rules :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/pir/authoring/markdown/index.xml" rel="alternate" type="application/rss+xml" title="Marrrkdown Rules :: Cap'n Hugo Relearrrn Theme">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1732007954" rel="icon" type="image/svg+xml">
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1732007954" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1732007954" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1732007954" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1732007954" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1732007954" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1732007954" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1732007954" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1732007954" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1732007954" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1732007954" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1732007954" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/print.css?1732007954" rel="stylesheet" media="print">
|
|
<link href="/hugo-theme-relearn/css/format-print.css?1732007954" rel="stylesheet">
|
|
<script src="/hugo-theme-relearn/js/variant.js?1732007954"></script>
|
|
<script>
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.relBasePath='..\/..\/..';
|
|
window.relearn.relBaseUri='..\/..\/..\/..';
|
|
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
|
window.relearn.disableAnchorCopy=false;
|
|
window.relearn.disableAnchorScrolling=false;
|
|
// variant stuff
|
|
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] );
|
|
// 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="/hugo-theme-relearn/pir/authoring/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+ALT+n)"><i class="fa-fw fas fa-bars"></i></button>
|
|
</div>
|
|
<div class="topbar-button topbar-button-toc" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Table o' Contents (CTRL+ALT+t)"><i class="fa-fw fas fa-list-alt"></i></button>
|
|
<div class="topbar-content">
|
|
<div class="topbar-content-wrapper">
|
|
<nav class="TableOfContents">
|
|
<ul>
|
|
<li><a href="#standard-and-extensions">Standard an' Extensions</a></li>
|
|
<li><a href="#paragraphs">Paragraphs</a></li>
|
|
<li><a href="#headings">Head'ns</a></li>
|
|
<li><a href="#horizontal-rules">Horizontal Rules</a></li>
|
|
<li><a href="#blockquotes">Blockquotes</a>
|
|
<ul>
|
|
<li><a href="#quotations">Quotat'ns</a></li>
|
|
<li><a href="#github-alerts">GitHub Alerts</a></li>
|
|
<li><a href="#obsidian-callouts">Obsidian Callouts</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#text-markers">Text Markers</a>
|
|
<ul>
|
|
<li><a href="#bold">Bold</a></li>
|
|
<li><a href="#italics">Italics</a></li>
|
|
<li><a href="#marked-text">Marked Text</a></li>
|
|
<li><a href="#inserted-text">Inserted Text</a></li>
|
|
<li><a href="#deleted-text">Deleted Text</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#special-typesetting">Special Typesett'n</a>
|
|
<ul>
|
|
<li><a href="#text-substitution">Text Substitut'n</a></li>
|
|
<li><a href="#subscript-and-superscript">Subscript an' Superscript</a></li>
|
|
<li><a href="#keyboard-shortcuts">Keyboard Shortcuts</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#lists">Lists</a>
|
|
<ul>
|
|
<li><a href="#unordered">Unordered</a></li>
|
|
<li><a href="#ordered">Ordered</a></li>
|
|
<li><a href="#tasks">Tasks</a></li>
|
|
<li><a href="#definitions">Definit'ns</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#code">Code</a>
|
|
<ul>
|
|
<li><a href="#inline-code">Inline Code</a></li>
|
|
<li><a href="#indented-code-block">Indented Code Block</a></li>
|
|
<li><a href="#fenced-code-block">Fenced Code Block</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#tables">Tables</a>
|
|
<ul>
|
|
<li><a href="#aligned-columns">Aligned Columns</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#links">Links</a>
|
|
<ul>
|
|
<li><a href="#autolink">Autolink</a></li>
|
|
<li><a href="#basic-link">Basic Link</a></li>
|
|
<li><a href="#link-with-tooltip">Link wit' Tooltip</a></li>
|
|
<li><a href="#link-references">Link References</a></li>
|
|
<li><a href="#footnotes">Footnotes</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#images">Images</a>
|
|
<ul>
|
|
<li><a href="#basic-images">Basic Images</a></li>
|
|
<li><a href="#image-with-tooltip">Image wit' Tooltip</a></li>
|
|
<li><a href="#image-references">Image References</a></li>
|
|
<li><a href="#image-effects">Image Effects</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</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="/hugo-theme-relearn/pir/authoring/index.html"><span itemprop="name">Rambl'n</span></a><meta itemprop="position" content="1"> > </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 class="topbar-button topbar-button-edit" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/authoring/markdown.pir.md" target="_self" title="Edit (CTRL+ALT+w)"><i class="fa-fw fas fa-pen"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-print" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/authoring/markdown/index.print.html" title="Prrrint whole chapterrr (CTRL+ALT+p)"><i class="fa-fw fas fa-print"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/authoring/meta/index.html" title="Meta Information (🡒)"><i class="fa-fw fas fa-chevron-left"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/pir/authoring/imageeffects/index.html" title="Image Effects (🡐)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-more" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Morrre"><i class="fa-fw fas fa-ellipsis-v"></i></button>
|
|
<div class="topbar-content">
|
|
<div class="topbar-content-wrapper">
|
|
<div class="topbar-area topbar-area-more" data-area="more">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="R-main-overlay"></div>
|
|
<main id="R-body-inner" class="highlightable authoring" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="marrrkdown-rules">Marrrkdown Rules</h1>
|
|
|
|
<p>Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.</p>
|
|
<p><strong>Marrrkdown</strong> be a better way t' write <strong>HTML</strong>, without all th' complexities an' ugliness that usually accompanies it.</p>
|
|
<p>Some o' th' key benefits be:</p>
|
|
<ol>
|
|
<li>Marrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n.</li>
|
|
<li>Less chance o' errors when writ'n 'n Marrrkdown.</li>
|
|
<li>Produces valid HTML output.</li>
|
|
<li>Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship.</li>
|
|
<li>Write 'n any text editor or Marrrkdown applicat'n ye like.</li>
|
|
<li>Marrrkdown be a joy t' use!</li>
|
|
</ol>
|
|
<p>John Gruber, th' author o' Marrrkdown, puts it like this:</p>
|
|
<blockquote>
|
|
<p>Th' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email.
|
|
<cite>John Gruber</cite></p>
|
|
</blockquote>
|
|
<div class="box notices cstyle tip">
|
|
<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 fer easy future reference!</p>
|
|
</div>
|
|
</div>
|
|
<h2 id="standard-and-extensions">Standard an' Extensions</h2>
|
|
<p>If not otherwise noted, th' shown examples adhere t' th' <a href="https://commonmark.org/help/" rel="external" target="_self">CommonMark</a> standard. In addit'n th' theme supports th' follow'n extensions that <a href="https://gohugo.io/getting-started/configuration-markup/#goldmark" rel="external" target="_self">can be activated</a> 'n yer <code>hugo.toml</code> or be built into th' theme:</p>
|
|
<ul>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> Extension on top o' standard Marrrkdown adher'n t' <a href="https://github.github.com/gfm/" rel="external" target="_self">GitHub Flavored Marrrkdown</a>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-php"></i></span><span class="badge-content" style="background-color: #888cc4;">PHP</span></span> Extension on top o' standard Marrrkdown adher'n t' <a href="https://michelf.ca/projects/php-markdown/extra/" rel="external" target="_self">PHP Marrrkdown</a>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-lightbulb"></i></span><span class="badge-content" style="background-color: darkorange;">Pants</span></span> Extension by John Gruber adher'n t' <a href="https://daringfireball.net/projects/smartypants/" rel="external" target="_self">SmartyPants</a>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">Cap'n Hugo</span></span> <a href="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel="external" target="_self">Cap'n Hugo Extra Extension</a> supported by Cap'n Hugo.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw far fa-gem"></i></span><span class="badge-content" style="background-color: #7c3aed;">Obsidian</span></span> Extension implemented by <a href="https://obsidian.md/" rel="external" target="_self">Obsidian</a>.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-code"></i></span><span class="badge-content" style="background-color: orangered;">HTML</span></span> If th' <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_self">usage o' HTML</a> be allowed, th' theme supports styl'n fer further HTML elements.</p>
|
|
</li>
|
|
<li>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-puzzle-piece"></i></span><span class="badge-content" style="background-color: #7dc903;">Relearrrn</span></span> Extension specific t' this theme.</p>
|
|
</li>
|
|
</ul>
|
|
<h2 id="paragraphs">Paragraphs</h2>
|
|
<p>In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.</p>
|
|
<p>Any text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl">Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>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’t use <code>h1</code> as this be generated by yer theme an' ye should only have one such element 'n a document.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="gh"># h1 Head'n
|
|
</span></span></span><span class="line"><span class="cl"><span class="gh"></span>
|
|
</span></span><span class="line"><span class="cl"><span class="gu">## h2 Head'n
|
|
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
|
</span></span><span class="line"><span class="cl"><span class="gu">### h3 Head'n
|
|
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
|
</span></span><span class="line"><span class="cl"><span class="gu">#### h4 Head'n
|
|
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
|
</span></span><span class="line"><span class="cl"><span class="gu">##### h5 Head'n
|
|
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
|
</span></span><span class="line"><span class="cl">###### h6 Head'n</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<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 “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes <code>---</code>.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
|
</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 code">
|
|
<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="blockquotes">Blockquotes</h2>
|
|
<h3 id="quotations">Quotat'ns</h3>
|
|
<p>For quot'n blocks o' rrrambl'n from another source within yer document add <code>></code> before any text ye want t' quote.</p>
|
|
<p>Blockquotes can also be nested.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">> </span><span class="ge">Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">>
|
|
</span></span></span><span class="line"><span class="cl"><span class="k"></span><span class="ge">> > Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span>>
|
|
</span></span><span class="line"><span class="cl">> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<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, 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>
|
|
<h3 id="github-alerts">GitHub Alerts</h3>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> Since Cap'n Hugo <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.132.0</span></span> <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts" rel="external" target="_self">GitHub alerts</a> be also supported. Please note, that color'n an' ay'cons o' severities may defer between GitHub an' this theme.</p>
|
|
<p>If ye be 'n need o' more advanced opt'ns t' style yer alerts, like ay'cons, use th' <a href="/hugo-theme-relearn/pir/shortcodes/notice/index.html">notice shortcode</a>.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!CAUTION]
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">> </span><span class="ge">Advises about risks or negative outcomes o' certain act'ns.
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">
|
|
</span></span></span><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!IMPORTANT]
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">> </span><span class="ge">Key informat'n users need t' know t' achieve their goal.
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">
|
|
</span></span></span><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!INFO]
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">> </span><span class="ge">Informat'n that users <ins>_might_</ins> find interest'n.
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">
|
|
</span></span></span><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!NOTE]
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">> </span><span class="ge">Useful informat'n that users should know, even when skimm'n rrrambl'n.
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">
|
|
</span></span></span><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!TIP]
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">> </span><span class="ge">Helpful advice fer do'n th'ns better or more easily.
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">
|
|
</span></span></span><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!WARNING]
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span>> Urgent info that needs immediate user attent'n t' avoid problems.</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<div class="box notices cstyle caution">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-hand"></i> Caut'n
|
|
</div>
|
|
<div class="box-content">
|
|
<p>Advises about risks or negative outcomes o' certain act'ns.</p>
|
|
</div>
|
|
</div>
|
|
<div class="box notices cstyle important">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-bolt"></i> Important
|
|
</div>
|
|
<div class="box-content">
|
|
<p>Key informat'n users need t' know t' achieve their goal.</p>
|
|
</div>
|
|
</div>
|
|
<div class="box notices cstyle info">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-info-circle"></i> Ahoi
|
|
</div>
|
|
<div class="box-content">
|
|
<p>Informat'n that users <ins><em>might</em></ins> find interest'n.</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>Useful informat'n that users should know, even when skimm'n rrrambl'n.</p>
|
|
</div>
|
|
</div>
|
|
<div class="box notices cstyle tip">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-lightbulb"></i> Smarrrt Arrrse
|
|
</div>
|
|
<div class="box-content">
|
|
<p>Helpful advice fer do'n th'ns better or more easily.</p>
|
|
</div>
|
|
</div>
|
|
<div class="box notices cstyle warning">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-exclamation-triangle"></i> Arrr
|
|
</div>
|
|
<div class="box-content">
|
|
<p>Urgent info that needs immediate user attent'n t' avoid problems.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="obsidian-callouts">Obsidian Callouts</h3>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw far fa-gem"></i></span><span class="badge-content" style="background-color: #7c3aed;">Obsidian</span></span> Since Cap'n Hugo <span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">0.134.0</span></span> <a href="https://help.obsidian.md/Editing+and+formatting/Callouts#Change+the+title" rel="external" target="_self">Obsidian callouts</a> be also supported. Which enables configur'ble title text an' expand/collapse.</p>
|
|
<p>If ye be 'n need o' more advanced opt'ns t' style yer alerts, like ay'cons, use th' <a href="/hugo-theme-relearn/pir/shortcodes/notice/index.html">notice shortcode</a>.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!tip] Callouts can have custom titles
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">> </span><span class="ge">Like this one.
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">
|
|
</span></span></span><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!tip] Title-only callout
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">
|
|
</span></span></span><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!note]- Be callouts fold'ble?
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">> </span><span class="ge">Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">
|
|
</span></span></span><span class="line"><span class="cl"><span class="k">> </span><span class="ge">[!note]+ Be callouts fold'ble?
|
|
</span></span></span><span class="line"><span class="cl"><span class="ge"></span>> Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<div class="box notices cstyle tip">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-lightbulb"></i> Callouts can have custom titles
|
|
</div>
|
|
<div class="box-content">
|
|
<p>Like this one.</p>
|
|
</div>
|
|
</div>
|
|
<div class="box notices cstyle tip">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-lightbulb"></i> Title-only callout
|
|
</div>
|
|
</div>
|
|
<div class="expand box notices cstyle note">
|
|
<input type="checkbox" id="R-expand-fe288f818da9c975b5bf9cd41f89835d" aria-controls="R-expandcontent-fe288f818da9c975b5bf9cd41f89835d">
|
|
<label class="expand-label box-label" for="R-expand-fe288f818da9c975b5bf9cd41f89835d">
|
|
<i class="expander-icon fa-fw fas fa-chevron-down"></i>
|
|
<i class="expander-icon fa-fw fas fa-chevron-right"></i> <i class="fa-fw fas fa-exclamation-circle"></i> Be callouts fold'ble?
|
|
</label>
|
|
<div class="box-spacer"></div>
|
|
<div id="R-expandcontent-fe288f818da9c975b5bf9cd41f89835d" class="box-content expand-content">
|
|
<p>Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed</p>
|
|
</div>
|
|
</div>
|
|
<div class="expand box notices cstyle note">
|
|
<input type="checkbox" id="R-expand-d84af83d75d85e7d46686bac8be18ebd" aria-controls="R-expandcontent-d84af83d75d85e7d46686bac8be18ebd" checked>
|
|
<label class="expand-label box-label" for="R-expand-d84af83d75d85e7d46686bac8be18ebd">
|
|
<i class="expander-icon fa-fw fas fa-chevron-down"></i>
|
|
<i class="expander-icon fa-fw fas fa-chevron-right"></i> <i class="fa-fw fas fa-exclamation-circle"></i> Be callouts fold'ble?
|
|
</label>
|
|
<div class="box-spacer"></div>
|
|
<div id="R-expandcontent-d84af83d75d85e7d46686bac8be18ebd" class="box-content expand-content">
|
|
<p>Yes! In a fold'ble callout, th' contents be hidden when th' callout be collapsed</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="text-markers">Text Markers</h2>
|
|
<h3 id="bold">Bold</h3>
|
|
<p>Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks <code>**</code>.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">I am rendered wit' **bold text**</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">I am rendered wit' _italicized text_</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>I am rendered wit' <em>italicized text</em></p>
|
|
</div>
|
|
</div>
|
|
<h3 id="marked-text">Marked Text</h3>
|
|
<p>Ye can mark text 'n th' predefined accent color o' yer stylesheet.</p>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">Cap'n Hugo</span></span> Since Cap'n Hugo 0.126.0, ye can <a href="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel="external" target="_self">activate this through th' <em>Cap'n Hugo Extra Extension</em></a> 'n yer <code>hugo.toml</code></p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">==Parts== o' this text ==are marked!==</span></span></code></pre></div>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-code"></i></span><span class="badge-content" style="background-color: orangered;">HTML</span></span> Ye can also use it by configur'n Hugo fer <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_self">usage o' HTML</a>.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl"><span class="p"><</span><span class="nt">mark</span><span class="p">></span>Parts<span class="p"></</span><span class="nt">mark</span><span class="p">></span> o' this text <span class="p"><</span><span class="nt">mark</span><span class="p">></span>be marked!<span class="p"></</span><span class="nt">mark</span><span class="p">></span></span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><mark>Parts</mark> o' this text <mark>be marked!</mark></p>
|
|
</div>
|
|
</div>
|
|
<h3 id="inserted-text">Inserted Text</h3>
|
|
<p>Ye can mark text addit'ns t' exist'n text.</p>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">Cap'n Hugo</span></span> Since Cap'n Hugo 0.126.0, ye can <a href="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel="external" target="_self">activate this through th' <em>Cap'n Hugo Extra Extension</em></a> 'n yer <code>hugo.toml</code></p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Th' ++hot, new++ stuff</span></span></code></pre></div>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-code"></i></span><span class="badge-content" style="background-color: orangered;">HTML</span></span> Ye can also use it by configur'n Hugo fer <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_self">usage o' HTML</a>.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl">Th' <span class="p"><</span><span class="nt">ins</span><span class="p">></span>hot, new<span class="p"></</span><span class="nt">ins</span><span class="p">></span> stuff</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>Th' <ins>hot, new</ins> stuff</p>
|
|
</div>
|
|
</div>
|
|
<h3 id="deleted-text">Deleted Text</h3>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> Ye can do strikethroughs by enclos'n text wit' two tildes <code>~~</code>. See <a href="https://gohugo.io/getting-started/configuration-markup/#extras" rel="external" target="_self">Hugo’s documentat'n remarks</a> if ye want t' use this together wit' th' subscript rules.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">~~Strike through~~ this text</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><del>Strike through</del> this text</p>
|
|
</div>
|
|
</div>
|
|
<h2 id="special-typesetting">Special Typesett'n</h2>
|
|
<h3 id="text-substitution">Text Substitut'n</h3>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-lightbulb"></i></span><span class="badge-content" style="background-color: darkorange;">Pants</span></span> Ye can combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Do'ble quotes <span class="sb">`"`</span> an' single quotes <span class="sb">`'`</span> o' enclosed text be replaced by <span class="ge">**</span>"do'ble curly quotes"** an' <span class="ge">**</span>'single curly quotes'**.
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl">Do'ble dashes <span class="sb">`--`</span> an' triple dashes <span class="sb">`---`</span> be replaced by en-dash <span class="ge">**</span>--** an' em-dash <span class="ge">**</span>---** entities.
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl">Do'ble arrows point'n left <span class="sb">`<<`</span> or right <span class="sb">`>>`</span> be replaced by arrow <span class="ge">**</span><span class="err"><<</span>** an' <span class="ge">**</span>>>** entities.
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl">Three consecutive dots <span class="sb">`...`</span> be replaced by an ellipsis <span class="ge">**</span>...** entity.</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>Do'ble quotes <code>"</code> an' single quotes <code>'</code> o' enclosed text be replaced by <strong>“do'ble curly quotes”</strong> an' <strong>‘single curly quotes’</strong>.</p>
|
|
<p>Do'ble dashes <code>--</code> an' triple dashes <code>---</code> be replaced by en-dash <strong>–</strong> an' em-dash <strong>—</strong> entities.</p>
|
|
<p>Do'ble arrows point'n left <code><<</code> or right <code>>></code> be replaced by arrow <strong>«</strong> an' <strong>»</strong> entities.</p>
|
|
<p>Three consecutive dots <code>...</code> be replaced by an ellipsis <strong>…</strong> entity.</p>
|
|
</div>
|
|
</div>
|
|
<h3 id="subscript-and-superscript">Subscript an' Superscript</h3>
|
|
<p>Ye can also use subscript an' superscript text. For more complex stuff, ye can use th' <a href="/hugo-theme-relearn/pir/shortcodes/math/index.html"><code>math</code> shortcode</a>.</p>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-hackerrank"></i></span><span class="badge-content" style="background-color: fuchsia;">Cap'n Hugo</span></span> Since Cap'n Hugo 0.126.0, ye can <a href="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel="external" target="_self">activate this through th' <em>Cap'n Hugo Extra Extension</em></a> 'n yer <code>hugo.toml</code></p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">How many liters H~2~O fit into 1dm^3^?</span></span></code></pre></div>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-code"></i></span><span class="badge-content" style="background-color: orangered;">HTML</span></span> Ye can also use it by configur'n Hugo fer <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_self">usage o' HTML</a>.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl">How many liters H<span class="p"><</span><span class="nt">sub</span><span class="p">></span>2<span class="p"></</span><span class="nt">sub</span><span class="p">></span>O fit into 1dm<span class="p"><</span><span class="nt">sup</span><span class="p">></span>3<span class="p"></</span><span class="nt">sup</span><span class="p">></span>?</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>How many liters H<sub>2</sub>O fit into 1dm<sup>3</sup>?</p>
|
|
</div>
|
|
</div>
|
|
<h3 id="keyboard-shortcuts">Keyboard Shortcuts</h3>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-code"></i></span><span class="badge-content" style="background-color: orangered;">HTML</span></span> Ye can use th' <code><kbd></code> element t' style keyboard shortcuts.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl">Press <span class="p"><</span><span class="nt">kbd</span><span class="p">></span>STRG<span class="p"></</span><span class="nt">kbd</span><span class="p">></span> <span class="p"><</span><span class="nt">kbd</span><span class="p">></span>ALT<span class="p"></</span><span class="nt">kbd</span><span class="p">></span> <span class="p"><</span><span class="nt">kbd</span><span class="p">></span>DEL<span class="p"></</span><span class="nt">kbd</span><span class="p">></span> t' end yer shift early.</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>Press <kbd>STRG</kbd> <kbd>ALT</kbd> <kbd>DEL</kbd> t' end yer shift early.</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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">-</span> Lorem ipsum dolor sit amet
|
|
</span></span><span class="line"><span class="cl"><span class="k">-</span> Consectetur adipisc'n elit
|
|
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Vestibulum laoreet porttitor sem
|
|
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Ac tristique libero volutpat at
|
|
</span></span><span class="line"><span class="cl"><span class="k">-</span> Nulla volutpat aliquam velit
|
|
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Phasellus iaculis neque
|
|
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Purus sodales ultricies
|
|
</span></span><span class="line"><span class="cl">- Faucibus porta lacus fringilla vel</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">1.</span> Lorem ipsum dolor sit amet
|
|
</span></span><span class="line"><span class="cl"><span class="k">3.</span> Consectetur adipisc'n elit
|
|
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Integer molestie lorem at massa
|
|
</span></span><span class="line"><span class="cl"> <span class="k">7.</span> Facilisis 'n pretium nisl aliquet
|
|
</span></span><span class="line"><span class="cl"><span class="k">99.</span> Nulla volutpat aliquam velit
|
|
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Faucibus porta lacus fringilla vel
|
|
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Aenean sit amet erat nunc
|
|
</span></span><span class="line"><span class="cl">17. Eget porttitor lorem</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<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><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> Ye can add task lists result'n 'n checked or unchecked non-click'ble items</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="k">- [x]</span> Basic Test
|
|
</span></span><span class="line"><span class="cl"><span class="k">- [ ]</span> More Tests
|
|
</span></span><span class="line"><span class="cl"> <span class="k">- [x]</span> View
|
|
</span></span><span class="line"><span class="cl"> <span class="k">- [x]</span> Hear
|
|
</span></span><span class="line"><span class="cl"> - [ ] Smell</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<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><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-php"></i></span><span class="badge-content" style="background-color: #888cc4;">PHP</span></span> Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.</p>
|
|
<p>A definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.</p>
|
|
<p>If ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Apple
|
|
</span></span><span class="line"><span class="cl">: Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae.
|
|
</span></span><span class="line"><span class="cl">: An American computer company.
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl">Orange
|
|
</span></span><span class="line"><span class="cl">: Th' fruit o' an evergreen tree o' th' genus Citrus.
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> Ye can make juice out o' it.
|
|
</span></span><span class="line"><span class="cl">: A telecommunicat'n company.
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> Ye can't make juice out o' it.</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<dl>
|
|
<dt>Apple</dt>
|
|
<dd>Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae.</dd>
|
|
<dd>An American computer company.</dd>
|
|
<dt>Orange</dt>
|
|
<dd>Th' fruit o' an evergreen tree o' th' genus Citrus.
|
|
<p>Ye can make juice out o' it.</p>
|
|
</dd>
|
|
<dd>A telecommunicat'n company.
|
|
<p>Ye can’t make juice out o' it.</p>
|
|
</dd>
|
|
</dl>
|
|
</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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">In this example, <span class="sb">`<div></div>`</span> be marked as code.</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>In this example, <code><div></div></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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Be impressed by my advanced code:
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> // Some comments
|
|
</span></span><span class="line"><span class="cl"> line 1 o' code
|
|
</span></span><span class="line"><span class="cl"> line 2 o' code
|
|
</span></span><span class="line"><span class="cl"> line 3 o' code</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>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><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> Ye can also add a language specifier directly after th' open'n fence, <code>```js</code>, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.</p>
|
|
<p>See <a href="/hugo-theme-relearn/pir/shortcodes/highlight/index.html">Code Highlight'n</a> fer additional documentat'n.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```js
|
|
</span></span><span class="line"><span class="cl">{
|
|
</span></span><span class="line"><span class="cl"> name: "Claus",
|
|
</span></span><span class="line"><span class="cl"> surname: "Santa",
|
|
</span></span><span class="line"><span class="cl"> profession: "courier",
|
|
</span></span><span class="line"><span class="cl"> age: 666,
|
|
</span></span><span class="line"><span class="cl"> address: {
|
|
</span></span><span class="line"><span class="cl"> city: "North Pole",
|
|
</span></span><span class="line"><span class="cl"> postalCode: 1,
|
|
</span></span><span class="line"><span class="cl"> country: "Arctic"
|
|
</span></span><span class="line"><span class="cl"> },
|
|
</span></span><span class="line"><span class="cl"> friends: [ "Dasher", "Dancer", "Prancer", "Vixen", "Comet", "Cupid", "Donder", "Blitzen", "Rudolph" ]
|
|
</span></span><span class="line"><span class="cl">};
|
|
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">name</span><span class="o">:</span> <span class="s2">"Claus"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">surname</span><span class="o">:</span> <span class="s2">"Santa"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">profession</span><span class="o">:</span> <span class="s2">"courier"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">age</span><span class="o">:</span> <span class="mi">666</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">address</span><span class="o">:</span> <span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">city</span><span class="o">:</span> <span class="s2">"North Pole"</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">postalCode</span><span class="o">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">country</span><span class="o">:</span> <span class="s2">"Arctic"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">},</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">friends</span><span class="o">:</span> <span class="p">[</span> <span class="s2">"Dasher"</span><span class="p">,</span> <span class="s2">"Dancer"</span><span class="p">,</span> <span class="s2">"Prancer"</span><span class="p">,</span> <span class="s2">"Vixen"</span><span class="p">,</span> <span class="s2">"Comet"</span><span class="p">,</span> <span class="s2">"Cupid"</span><span class="p">,</span> <span class="s2">"Donder"</span><span class="p">,</span> <span class="s2">"Blitzen"</span><span class="p">,</span> <span class="s2">"Rudolph"</span> <span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">};</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<h2 id="tables">Tables</h2>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> Ye can create tables by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">| Opt'n | Descript'n |
|
|
</span></span><span class="line"><span class="cl">|--------|-------------|
|
|
</span></span><span class="line"><span class="cl">| data | path t' data files t' supply th' data that will be passed into templates. |
|
|
</span></span><span class="line"><span class="cl">| engine | engine t' be used fer process'n templates. Handlebars be th' default. |
|
|
</span></span><span class="line"><span class="cl">| ext | extension t' be used fer dest files. |</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">| Opt'n | Number | Descript'n |
|
|
</span></span><span class="line"><span class="cl">|-------:|:------:|:------------|
|
|
</span></span><span class="line"><span class="cl">| data | 1 | path t' data files t' supply th' data that will be passed into templates. |
|
|
</span></span><span class="line"><span class="cl">| engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. |
|
|
</span></span><span class="line"><span class="cl">| ext | 3 | extension t' be used fer dest files. |</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</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="links">Links</h2>
|
|
<h3 id="autolink">Autolink</h3>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-github"></i></span><span class="badge-content" style="background-color: darkgray;">GFM</span></span> Absolute URLs will automatically be converted into a link.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">This be a link t' https://example.com.</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>This be a link t' <a href="https://example.com" rel="external" target="_self">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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">[<span class="nt">Assemble</span>](<span class="na">http://assemble.io</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="http://assemble.io" rel="external" target="_self">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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">[<span class="nt">Upstage</span>](<span class="na">https://github.com/upstage/ "Visit Upstage!"</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="https://github.com/upstage/" rel="external" target="_self" title="Visit Upstage!">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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">[Example][somelinkID]
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl">[somelinkID]: https://example.com "Go t' example domain"</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="https://example.com" rel="external" target="_self" title="Go t' example domain">Example</a></p>
|
|
</div>
|
|
</div>
|
|
<h3 id="footnotes">Footnotes</h3>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-php"></i></span><span class="badge-content" style="background-color: #888cc4;">PHP</span></span> Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.</p>
|
|
<p>Usually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.</p>
|
|
<p>Footnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">That's some text wit' a footnote[^1]
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl">[^1]: An' that's th' footnote.
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl">That'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 code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p>That’s some text wit' a footnote<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></p>
|
|
<p>That’s some more text wit' a footnote.<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></p>
|
|
<div class="footnotes" role="doc-endnotes">
|
|
<hr>
|
|
<ol>
|
|
<li id="fn:1">
|
|
<p>An' that’s th' footnote. <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
|
</li>
|
|
<li id="fn:2">
|
|
<p>Anyth'n o' interest goes here.</p>
|
|
<p>Blue light glows blue. <a href="#fnref:2" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
|
</li>
|
|
</ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="images">Images</h2>
|
|
<h3 id="basic-images">Basic Images</h3>
|
|
<p>Images have a similar rules t' links but include a preced'n exclamat'n mark.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Spock</span>](<span class="na">https://octodex.github.com/images/spocktocat.png</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-70cfb2ec0922ebe65da3d99a73e2761e" class="lightbox-link"><img alt="Spock" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/spocktocat.png?width=20vw" style=" height: auto; width: 20vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-70cfb2ec0922ebe65da3d99a73e2761e"><img alt="Spock" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/spocktocat.png?width=20vw"></a></p>
|
|
</div>
|
|
</div>
|
|
<h3 id="image-with-tooltip">Image wit' Tooltip</h3>
|
|
<p>Like links, images can also be given a tooltip.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Picard</span>](<span class="na">https://octodex.github.com/images/jean-luc-picat.jpg "Jean Luc Picard"</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-f831d1ea454380a413408ca96719e6f4" class="lightbox-link"><img alt="Picard" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" style=" height: auto; width: 20vw;" title="Jean Luc Picard"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-f831d1ea454380a413408ca96719e6f4"><img alt="Picard" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" title="Jean Luc Picard"></a></p>
|
|
</div>
|
|
</div>
|
|
<h3 id="image-references">Image References</h3>
|
|
<p>Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![La Forge][laforge]
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl">[laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-d9d8a569f278162b73cbd7376f0cae27" class="lightbox-link"><img alt="La Forge" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/trekkie.jpg?width=20vw" style=" height: auto; width: 20vw;" title="Geordi La Forge"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-d9d8a569f278162b73cbd7376f0cae27"><img alt="La Forge" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/trekkie.jpg?width=20vw" title="Geordi La Forge"></a></p>
|
|
</div>
|
|
</div>
|
|
<h3 id="image-effects">Image Effects</h3>
|
|
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-puzzle-piece"></i></span><span class="badge-content" style="background-color: #7dc903;">Relearrrn</span></span> This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. See th' <a href="/hugo-theme-relearn/pir/authoring/imageeffects/index.html">image effects docs</a> fer a detailed example an' how t' configure it.</p>
|
|
<h4 id="resizing">Resiz'n</h4>
|
|
<p>Add query parameter <code>width</code> and/or <code>height</code> t' th' link image t' resize th' image. Values be CSS values (default be <code>auto</code>).</p>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?width=20vw</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-696ec0749a0b635e9b88a0a26f1bb438" class="lightbox-link"><img alt="Minion" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/minion.png?width=20vw" style=" height: auto; width: 20vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-696ec0749a0b635e9b88a0a26f1bb438"><img alt="Minion" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/minion.png?width=20vw"></a></p>
|
|
</div>
|
|
</div>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?height=50px</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-15bf8e415efdf5e54f56d2da52c51047" class="lightbox-link"><img alt="Minion" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/minion.png?height=50px" style=" height: 50px; width: auto;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-15bf8e415efdf5e54f56d2da52c51047"><img alt="Minion" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/minion.png?height=50px"></a></p>
|
|
</div>
|
|
</div>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Minion</span>](<span class="na">https://octodex.github.com/images/minion.png?height=50px&width=40vw</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-f80cb16ba9cc1bd868e1d65202455dda" class="lightbox-link"><img alt="Minion" class="bg-white border lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/minion.png?height=50px&width=40vw" style=" height: 50px; width: 40vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-f80cb16ba9cc1bd868e1d65202455dda"><img alt="Minion" class="bg-white border lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/minion.png?height=50px&width=40vw"></a></p>
|
|
</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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Spidertocat</span>](<span class="na">https://octodex.github.com/images/spidertocat.png?classes=shadow</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-212a0ab803f55b319d8ee756735be359" class="lightbox-link"><img alt="Spidertocat" class="bg-white border lazy lightbox noborder shadow figure-image" loading="lazy" src="https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" style=" height: auto; width: 20vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-212a0ab803f55b319d8ee756735be359"><img alt="Spidertocat" class="bg-white border lazy lightbox noborder shadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder"></a></p>
|
|
</div>
|
|
</div>
|
|
<h5 id="border">Border</h5>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">DrOctocat</span>](<span class="na">https://octodex.github.com/images/droctocat.png?classes=border</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-36fc7e48b159c1a269155f9acd6757f4" class="lightbox-link"><img alt="DrOctocat" class="bg-white border lazy lightbox noshadow noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" style=" height: auto; width: 20vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-36fc7e48b159c1a269155f9acd6757f4"><img alt="DrOctocat" class="bg-white border lazy lightbox noshadow noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow"></a></p>
|
|
</div>
|
|
</div>
|
|
<h5 id="left">Left</h5>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Supertocat</span>](<span class="na">https://octodex.github.com/images/okal-eltocat.jpg?classes=left</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-a552515ead6306dc4f284f13a9218984" class="lightbox-link"><img alt="Supertocat" class="bg-white border lazy left lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" style=" height: auto; width: 20vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-a552515ead6306dc4f284f13a9218984"><img alt="Supertocat" class="bg-white border lazy left lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left"></a></p>
|
|
</div>
|
|
</div>
|
|
<h5 id="right">Right</h5>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Riddlocat</span>](<span class="na">https://octodex.github.com/images/riddlocat.jpg?classes=right</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-2ea7f6073bff1b43db6e48db0d972804" class="lightbox-link"><img alt="Riddlocat" class="bg-white border lazy lightbox right noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" style=" height: auto; width: 20vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-2ea7f6073bff1b43db6e48db0d972804"><img alt="Riddlocat" class="bg-white border lazy lightbox right noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right"></a></p>
|
|
</div>
|
|
</div>
|
|
<h5 id="inline">Inline</h5>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Spidertocat</span>](<span class="na">https://octodex.github.com/images/spidertocat.png?classes=inline</span>)
|
|
</span></span><span class="line"><span class="cl">![<span class="nt">DrOctocat</span>](<span class="na">https://octodex.github.com/images/droctocat.png?classes=inline</span>)
|
|
</span></span><span class="line"><span class="cl">![<span class="nt">Supertocat</span>](<span class="na">https://octodex.github.com/images/okal-eltocat.jpg?classes=inline</span>)
|
|
</span></span><span class="line"><span class="cl">![<span class="nt">Riddlocat</span>](<span class="na">https://octodex.github.com/images/riddlocat.jpg?classes=inline</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-e7c296ada9c39fe69a35be235498f325" class="lightbox-link"><img alt="Spidertocat" class="bg-white border inline lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" style=" height: auto; width: 10vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-e7c296ada9c39fe69a35be235498f325"><img alt="Spidertocat" class="bg-white border inline lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline"></a>
|
|
<a href="#R-image-11362bd3af153d66607e7861f01faf3b" class="lightbox-link"><img alt="DrOctocat" class="bg-white border inline lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" style=" height: auto; width: 10vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-11362bd3af153d66607e7861f01faf3b"><img alt="DrOctocat" class="bg-white border inline lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline"></a>
|
|
<a href="#R-image-5f9c4caa0679386029317b62b84a9782" class="lightbox-link"><img alt="Supertocat" class="bg-white border inline lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" style=" height: auto; width: 10vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-5f9c4caa0679386029317b62b84a9782"><img alt="Supertocat" class="bg-white border inline lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline"></a>
|
|
<a href="#R-image-e2301558f19e6f7b1ff4814b6b1cf226" class="lightbox-link"><img alt="Riddlocat" class="bg-white border inline lazy lightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" style=" height: auto; width: 10vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-e2301558f19e6f7b1ff4814b6b1cf226"><img alt="Riddlocat" class="bg-white border inline lazy lightbox noshadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline"></a></p>
|
|
</div>
|
|
</div>
|
|
<h5 id="combination">Combinat'n</h5>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">X-tocat</span>](<span class="na">https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><a href="#R-image-ed63014a5678b0ed2d7a932def302605" class="lightbox-link"><img alt="X-tocat" class="bg-white border lazy left lightbox shadow figure-image" loading="lazy" src="https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" style=" height: auto; width: 20vw;"></a>
|
|
<a href="javascript:history.back();" class="lightbox-back" id="R-image-ed63014a5678b0ed2d7a932def302605"><img alt="X-tocat" class="bg-white border lazy left lightbox shadow lightbox-image" loading="lazy" src="https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left"></a></p>
|
|
</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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">![<span class="nt">Homercat</span>](<span class="na">https://octodex.github.com/images/homercat.png?lightbox=false</span>)</span></span></code></pre></div>
|
|
<div class="box notices cstyle code">
|
|
<div class="box-label">
|
|
<i class="fa-fw fas fa-eye"></i> Result
|
|
</div>
|
|
<div class="box-content">
|
|
<p><img alt="Homercat" class="bg-white border lazy nolightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" style=" height: auto; width: 20vw;"></p>
|
|
</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="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">[<span class="nt">![Homercat</span>](<span class="na">https://octodex.github.com/images/homercat.png?lightbox=false</span>)](https://octodex.github.com/#homercat)</span></span></code></pre></div>
|
|
<p><a href="https://octodex.github.com/#homercat" rel="external" target="_self"><img alt="Homercat" class="bg-white border lazy nolightbox noshadow figure-image" loading="lazy" src="https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" style=" height: auto; width: 20vw;"></a></p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<footer class="footline">
|
|
<div class="R-taxonomy taxonomy-categories cstyle" title="Categorrries" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
|
<i class="fa-fw fas fa-layer-group"></i>
|
|
<ul>
|
|
<li><a class="term-link" href="/hugo-theme-relearn/pir/categories/howto/index.html">Howto</a></li>
|
|
<li><a class="term-link" href="/hugo-theme-relearn/pir/categories/reference/index.html">Reference</a></li>
|
|
</ul>
|
|
</div>
|
|
</footer>
|
|
</article>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1732007954" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1732007954" defer></script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1732007954" defer></script>
|
|
</body>
|
|
</html>
|