mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 15:57:57 +00:00
905 lines
75 KiB
HTML
905 lines
75 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en" dir="ltr" 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.132.0">
|
||
<meta name="generator" content="Relearn 6.1.1+tip">
|
||
<meta name="description" content="Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.">
|
||
<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="Markdown Syntax :: Hugo Relearn Theme">
|
||
<meta name="twitter:description" content="Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.">
|
||
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/cont/markdown/index.html">
|
||
<meta property="og:site_name" content="Hugo Relearn Theme">
|
||
<meta property="og:title" content="Markdown Syntax :: Hugo Relearn Theme">
|
||
<meta property="og:description" content="Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.">
|
||
<meta property="og:locale" content="en">
|
||
<meta property="og:type" content="article">
|
||
<meta property="article:section" content="Content">
|
||
<meta property="article:tag" content="Content">
|
||
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
||
<meta itemprop="name" content="Markdown Syntax :: Hugo Relearn Theme">
|
||
<meta itemprop="description" content="Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.">
|
||
<meta itemprop="wordCount" content="2926">
|
||
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
||
<meta itemprop="keywords" content="Content">
|
||
<title>Markdown Syntax :: Hugo Relearn 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-x-pir">
|
||
<link href="https://mcshelby.github.io/hugo-theme-relearn/cont/markdown/index.html" rel="canonical" type="text/html" title="Markdown Syntax :: Hugo Relearn Theme">
|
||
<link href="/hugo-theme-relearn/cont/markdown/index.xml" rel="alternate" type="application/rss+xml" title="Markdown Syntax :: Hugo Relearn Theme">
|
||
<link href="/hugo-theme-relearn/images/logo.svg?1723555287" rel="icon" type="image/svg+xml">
|
||
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1723555287" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1723555287" rel="stylesheet"></noscript>
|
||
<link href="/hugo-theme-relearn/css/nucleus.css?1723555287" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/auto-complete.css?1723555287" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1723555287" rel="stylesheet"></noscript>
|
||
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1723555287" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/fonts.css?1723555287" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1723555287" rel="stylesheet"></noscript>
|
||
<link href="/hugo-theme-relearn/css/theme.css?1723555287" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1723555287" rel="stylesheet" id="R-variant-style">
|
||
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1723555287" rel="stylesheet" id="R-variant-chroma-style">
|
||
<link href="/hugo-theme-relearn/css/variant.css?1723555287" rel="stylesheet">
|
||
<link href="/hugo-theme-relearn/css/print.css?1723555287" rel="stylesheet" media="print">
|
||
<link href="/hugo-theme-relearn/css/format-print.css?1723555287" rel="stylesheet">
|
||
<script src="/hugo-theme-relearn/js/variant.js?1723555287"></script>
|
||
<script>
|
||
window.relearn = window.relearn || {};
|
||
window.relearn.relBasePath='..\/..';
|
||
window.relearn.relBaseUri='..\/..\/..';
|
||
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
||
window.index_js_url="/hugo-theme-relearn/index.search.js?1723555287";
|
||
// 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 to clipboard`;
|
||
window.T_Copied_to_clipboard = `Copied to clipboard!`;
|
||
window.T_Copy_link_to_clipboard = `Copy link to clipboard`;
|
||
window.T_Link_copied_to_clipboard = `Copied link to clipboard!`;
|
||
window.T_Reset_view = `Reset view`;
|
||
window.T_View_reset = `View reset!`;
|
||
window.T_No_results_found = `No results found for "{0}"`;
|
||
window.T_N_results_found = `{1} results found for "{0}"`;
|
||
</script>
|
||
<style>
|
||
#R-body img.bg-white {
|
||
background-color: white;
|
||
}
|
||
</style>
|
||
</head>
|
||
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/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+ALT+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="/hugo-theme-relearn/cont/index.html"><span itemprop="name">Content</span></a><meta itemprop="position" content="1"> > </li><li
|
||
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Markdown Syntax</span><meta itemprop="position" content="2"></li>
|
||
</ol>
|
||
<div class="topbar-area topbar-area-end" data-area="end">
|
||
<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/cont/archetypes/index.html" title="Archetypes (🡐)"><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/cont/imageeffects/index.html" title="Image Effects (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
||
</div>
|
||
</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="Tags" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
||
<ul>
|
||
<li><a class="term-link" href="/hugo-theme-relearn/tags/content/index.html">Content</a></li>
|
||
</ul>
|
||
</div>
|
||
</header>
|
||
|
||
<h1 id="markdown-syntax">Markdown Syntax</h1>
|
||
|
||
<p>Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.</p>
|
||
<p><strong>Markdown</strong> is a better way to write <strong>HTML</strong>, without all the complexities and ugliness that usually accompanies it.</p>
|
||
<p>Some of the key benefits are:</p>
|
||
<ol>
|
||
<li>Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content.</li>
|
||
<li>Less chance of errors when writing in Markdown.</li>
|
||
<li>Produces valid HTML output.</li>
|
||
<li>Keeps the content and the visual display separate, so you cannot mess up the look of your site.</li>
|
||
<li>Write in any text editor or Markdown application you like.</li>
|
||
<li>Markdown is a joy to use!</li>
|
||
</ol>
|
||
<p>John Gruber, the author of Markdown, puts it like this:</p>
|
||
|
||
<blockquote><p>The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
|
||
<cite>John Gruber</cite></p>
|
||
|
||
</blockquote>
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
|
||
<p><i class="fa-fw fas fa-bookmark"></i> Bookmark this page for easy future reference!</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="standard-and-extensions">Standard and Extensions</h2>
|
||
<p>If not otherwise noted, the shown examples adhere to the <a href="https://commonmark.org/help/" rel="external" target="_self">Commonmark</a> standard. In addition the theme supports the following extensions that <a href="https://gohugo.io/getting-started/configuration-markup/#goldmark" rel="external" target="_self">can be activated</a> in your <code>hugo.toml</code> or are built into the 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 of standard Markdown adhering to <a href="https://github.github.com/gfm/" rel="external" target="_self">GitHub Flavored Markdown</a>.</p>
|
||
</li>
|
||
<li>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content" style="background-color: #888cc4;">PHP</span></span> Extension on top of standard Markdown adhering to <a href="https://michelf.ca/projects/php-markdown/extra/" rel="external" target="_self">PHP Markdown</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 adhering to <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;">Hugo</span></span> <a href="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel="external" target="_self">Hugo Extra Extension</a> supported by Hugo.</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;">Relearn</span></span> Extension specific to this theme.</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 the <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_self">usage of HTML</a> is allowed, the theme supports styling for further HTML elements.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="paragraphs">Paragraphs</h2>
|
||
<p>In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.</p>
|
||
<p>Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.</p>
|
||
<div class="highlight 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">Headings</h2>
|
||
<p>A good idea is to structure your content using headings and subheadings. HTML-headings from <code>h1</code> through <code>h6</code> are constructed with a <code>#</code> for each level.</p>
|
||
<p>In Hugo you usually don’t use <code>h1</code> as this is generated by your theme and you should only have one such element in a document.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="gh"># h1 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gh"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gu">## h2 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gu">### h3 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gu">#### h4 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl"><span class="gu">##### h5 Heading
|
||
</span></span></span><span class="line"><span class="cl"><span class="gu"></span>
|
||
</span></span><span class="line"><span class="cl">###### h6 Heading</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 Heading</h1>
|
||
<h2 id="h2-heading">h2 Heading</h2>
|
||
<h3 id="h3-heading">h3 Heading</h3>
|
||
<h4 id="h4-heading">h4 Heading</h4>
|
||
<h5 id="h5-heading">h5 Heading</h5>
|
||
<h6 id="h6-heading">h6 Heading</h6>
|
||
</div>
|
||
</div>
|
||
<h2 id="horizontal-rules">Horizontal Rules</h2>
|
||
<p>To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes <code>---</code>.</p>
|
||
<div class="highlight 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>
|
||
<p>For quoting blocks of content from another source within your document add <code>></code> before any text you want to quote.</p>
|
||
<p>Blockquotes can also be nested.</p>
|
||
<div class="highlight 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 in, 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 adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
||
</span></span></span><span class="line"><span class="cl"><span class="ge"></span>>
|
||
</span></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 in, fermentum sed augue. Nunc augue, aliquam non hendrerit ac, commodo vel nisi.</p>
|
||
|
||
<blockquote><p>Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.</p>
|
||
|
||
</blockquote><p>Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</p>
|
||
|
||
</blockquote></div>
|
||
</div>
|
||
<h2 id="alerts">Alerts</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> Since 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 styled alerts</a> are also supported. Please note, that coloring and icons of severities may defer between GitHub and this theme.</p>
|
||
<p>If you are in need of more advanced options to style your alerts, use the <a href="/hugo-theme-relearn/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 of certain actions.
|
||
</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 information users need to know to 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">Information that users <ins>_might_</ins> find interesting.
|
||
</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 information that users should know, even when skimming content.
|
||
</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 for doing things 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 attention to 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> Caution</div>
|
||
<div class="box-content">
|
||
|
||
<p>Advises about risks or negative outcomes of certain actions.</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 information users need to know to 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> Info</div>
|
||
<div class="box-content">
|
||
|
||
<p>Information that users <ins><em>might</em></ins> find interesting.</p></div>
|
||
</div>
|
||
<div class="box notices cstyle note">
|
||
<div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> Note</div>
|
||
<div class="box-content">
|
||
|
||
<p>Useful information that users should know, even when skimming content.</p>
|
||
</div>
|
||
</div>
|
||
<div class="box notices cstyle tip">
|
||
<div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div>
|
||
<div class="box-content">
|
||
|
||
<p>Helpful advice for doing things 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> Warning</div>
|
||
<div class="box-content">
|
||
|
||
<p>Urgent info that needs immediate user attention to avoid problems.</p>
|
||
</div>
|
||
</div></div>
|
||
</div>
|
||
<h2 id="text-markers">Text Markers</h2>
|
||
<h3 id="bold">Bold</h3>
|
||
<p>You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks <code>**</code>.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">I am rendered with **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 with <strong>bold text</strong></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="italics">Italics</h3>
|
||
<p>You can emphasize a snippet of text with italics by enclosing it with underscores <code>_</code>.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">I am rendered with _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 with <em>italicized text</em></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="marked-text">Marked Text</h3>
|
||
<p>You can mark text in the predefined accent color of your 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;">Hugo</span></span> Since Hugo 0.126.0, you can <a href="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel="external" target="_self">activate this through the <em>Hugo Extra Extension</em></a> in your <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== of 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> You can also use it by configuring Hugo for <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_self">usage of 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> of this text <span class="p"><</span><span class="nt">mark</span><span class="p">></span>are 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> of this text <mark>are marked!</mark></p>
|
||
</div>
|
||
</div>
|
||
<h3 id="inserted-text">Inserted Text</h3>
|
||
<p>You can mark text additions to existing 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;">Hugo</span></span> Since Hugo 0.126.0, you can <a href="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel="external" target="_self">activate this through the <em>Hugo Extra Extension</em></a> in your <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">The ++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> You can also use it by configuring Hugo for <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_self">usage of 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">The <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>The <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> You can do strikethroughs by enclosing text with two tildes <code>~~</code>. See <a href="https://gohugo.io/getting-started/configuration-markup/#extras" rel="external" target="_self">Hugo’s documentation remarks</a> if you want to use this together with the subscript syntax.</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 Typesetting</h2>
|
||
<h3 id="text-substitution">Text Substitution</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> You can combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">Double quotes <span class="sb">`"`</span> and single quotes <span class="sb">`'`</span> of enclosed text are replaced by <span class="ge">**</span>"double curly quotes"** and <span class="ge">**</span>'single curly quotes'**.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Double dashes <span class="sb">`--`</span> and triple dashes <span class="sb">`---`</span> are replaced by en-dash <span class="ge">**</span>--** and em-dash <span class="ge">**</span>---** entities.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Double arrows pointing left <span class="sb">`<<`</span> or right <span class="sb">`>>`</span> are replaced by arrow <span class="ge">**</span><span class="err"><<</span>** and <span class="ge">**</span>>>** entities.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Three consecutive dots <span class="sb">`...`</span> are replaced by an ellipsis <span class="ge">**</span>...** entity.</span></span></code></pre></div>
|
||
<div class="box notices cstyle code">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>Double quotes <code>"</code> and single quotes <code>'</code> of enclosed text are replaced by <strong>“double curly quotes”</strong> and <strong>‘single curly quotes’</strong>.</p>
|
||
<p>Double dashes <code>--</code> and triple dashes <code>---</code> are replaced by en-dash <strong>–</strong> and em-dash <strong>—</strong> entities.</p>
|
||
<p>Double arrows pointing left <code><<</code> or right <code>>></code> are replaced by arrow <strong>«</strong> and <strong>»</strong> entities.</p>
|
||
<p>Three consecutive dots <code>...</code> are replaced by an ellipsis <strong>…</strong> entity.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="subscript-and-superscript">Subscript and Superscript</h3>
|
||
<p>You can also use subscript and superscript text. For more complex stuff, you can use the <a href="/hugo-theme-relearn/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;">Hugo</span></span> Since Hugo 0.126.0, you can <a href="https://github.com/gohugoio/hugo-goldmark-extensions?tab=readme-ov-file#extras-extension" rel="external" target="_self">activate this through the <em>Hugo Extra Extension</em></a> in your <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> You can also use it by configuring Hugo for <a href="https://gohugo.io/getting-started/configuration-markup/#rendererunsafe" rel="external" target="_self">usage of 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> You can use the <code><kbd></code> element to 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> to end your 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> to end your shift early.</p>
|
||
</div>
|
||
</div>
|
||
<h2 id="lists">Lists</h2>
|
||
<h3 id="unordered">Unordered</h3>
|
||
<p>You can write a list of items in which the order of the items does not explicitly matter.</p>
|
||
<p>It is possible to nest lists by indenting an item for the next sublevel.</p>
|
||
<p>You may use any of <code>-</code>, <code>*</code> or <code>+</code> to denote bullets for each list item but should not switch between those symbols inside one whole list.</p>
|
||
<div class="highlight 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 adipiscing elit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Vestibulum laoreet porttitor sem
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Ac tristique libero volutpat at
|
||
</span></span><span class="line"><span class="cl"><span class="k">-</span> Nulla volutpat aliquam velit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Phasellus iaculis neque
|
||
</span></span><span class="line"><span class="cl"> <span class="k">-</span> Purus sodales ultricies
|
||
</span></span><span class="line"><span class="cl">- 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 adipiscing elit
|
||
<ul>
|
||
<li>Vestibulum laoreet porttitor sem</li>
|
||
<li>Ac tristique libero volutpat at</li>
|
||
</ul>
|
||
</li>
|
||
<li>Nulla volutpat aliquam velit
|
||
<ul>
|
||
<li>Phasellus iaculis neque</li>
|
||
<li>Purus sodales ultricies</li>
|
||
</ul>
|
||
</li>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<h3 id="ordered">Ordered</h3>
|
||
<p>You can create a list of items in which the order of items does explicitly matter.</p>
|
||
<p>It is possible to nest lists by indenting an item for the next sublevel.</p>
|
||
<p>Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.</p>
|
||
<div class="highlight 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 adipiscing elit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Integer molestie lorem at massa
|
||
</span></span><span class="line"><span class="cl"> <span class="k">7.</span> Facilisis in pretium nisl aliquet
|
||
</span></span><span class="line"><span class="cl"><span class="k">99.</span> Nulla volutpat aliquam velit
|
||
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Faucibus porta lacus fringilla vel
|
||
</span></span><span class="line"><span class="cl"> <span class="k">1.</span> Aenean sit amet erat nunc
|
||
</span></span><span class="line"><span class="cl">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 adipiscing elit
|
||
<ol>
|
||
<li>Integer molestie lorem at massa</li>
|
||
<li>Facilisis in pretium nisl aliquet</li>
|
||
</ol>
|
||
</li>
|
||
<li>Nulla volutpat aliquam velit
|
||
<ol>
|
||
<li>Faucibus porta lacus fringilla vel</li>
|
||
<li>Aenean sit amet erat nunc</li>
|
||
</ol>
|
||
</li>
|
||
<li>Eget porttitor lorem</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
<h3 id="tasks">Tasks</h3>
|
||
<p><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> You can add task lists resulting in checked or unchecked non-clickable 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">Definitions</h3>
|
||
<p><span class="badge cstyle default badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content" style="background-color: #888cc4;">PHP</span></span> Definition lists are made of terms and definitions of these terms, much like in a dictionary.</p>
|
||
<p>A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.</p>
|
||
<p>If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible</p>
|
||
<div class="highlight 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 of plants of the genus Malus in the family Rosaceae.
|
||
</span></span><span class="line"><span class="cl">: An American computer company.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">Orange
|
||
</span></span><span class="line"><span class="cl">: The fruit of an evergreen tree of the genus Citrus.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> You can make juice out of it.
|
||
</span></span><span class="line"><span class="cl">: A telecommunication company.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> You can't make juice out of it.</span></span></code></pre></div>
|
||
<div class="box notices cstyle 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 of plants of the genus Malus in the family Rosaceae.</dd>
|
||
<dd>An American computer company.</dd>
|
||
<dt>Orange</dt>
|
||
<dd>The fruit of an evergreen tree of the genus Citrus.
|
||
<p>You can make juice out of it.</p>
|
||
</dd>
|
||
<dd>A telecommunication company.
|
||
<p>You can’t make juice out of it.</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</div>
|
||
<h2 id="code">Code</h2>
|
||
<h3 id="inline-code">Inline Code</h3>
|
||
<p>Inline snippets of code can be wrapped with backticks <code>`</code>.</p>
|
||
<div class="highlight 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> is 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> is marked as code.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="indented-code-block">Indented Code Block</h3>
|
||
<p>A simple code block can be generated by indenting several lines of code by at least two spaces.</p>
|
||
<div class="highlight 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 of code
|
||
</span></span><span class="line"><span class="cl"> line 2 of code
|
||
</span></span><span class="line"><span class="cl"> line 3 of code</span></span></code></pre></div>
|
||
<div class="box notices cstyle 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 of code
|
||
line 2 of code
|
||
line 3 of code
|
||
</code></pre>
|
||
</div>
|
||
</div>
|
||
<h3 id="fenced-code-block">Fenced Code Block</h3>
|
||
<p>If you want to gain more control of your code block you can enclose your code by at least three backticks <code>```</code> a so called fence.</p>
|
||
<p><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> You can also add a language specifier directly after the opening fence, <code>```js</code>, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.</p>
|
||
<p>See <a href="/hugo-theme-relearn/shortcodes/highlight/index.html">Code Highlighting</a> for additional documentation.</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> You can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">| Option | Description |
|
||
</span></span><span class="line"><span class="cl">|--------|-------------|
|
||
</span></span><span class="line"><span class="cl">| data | path to data files to supply the data that will be passed into templates. |
|
||
</span></span><span class="line"><span class="cl">| engine | engine to be used for processing templates. Handlebars is the default. |
|
||
</span></span><span class="line"><span class="cl">| ext | extension to be used for dest files. |</span></span></code></pre></div>
|
||
<div class="box notices cstyle code">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>data</td>
|
||
<td>path to data files to supply the data that will be passed into templates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>engine</td>
|
||
<td>engine to be used for processing templates. Handlebars is the default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td>ext</td>
|
||
<td>extension to be used for dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<h3 id="aligned-columns">Aligned Columns</h3>
|
||
<p>Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">| Option | Number | Description |
|
||
</span></span><span class="line"><span class="cl">|-------:|:------:|:------------|
|
||
</span></span><span class="line"><span class="cl">| data | 1 | path to data files to supply the data that will be passed into templates. |
|
||
</span></span><span class="line"><span class="cl">| engine | 2 | engine to be used for processing templates. Handlebars is the default. |
|
||
</span></span><span class="line"><span class="cl">| ext | 3 | extension to be used for dest files. |</span></span></code></pre></div>
|
||
<div class="box notices cstyle 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">Option</th>
|
||
<th style="text-align:center">Number</th>
|
||
<th style="text-align:left">Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td style="text-align:right">data</td>
|
||
<td style="text-align:center">1</td>
|
||
<td style="text-align:left">path to data files to supply the data that will be passed into templates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:right">engine</td>
|
||
<td style="text-align:center">2</td>
|
||
<td style="text-align:left">engine to be used for processing templates. Handlebars is the default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td style="text-align:right">ext</td>
|
||
<td style="text-align:center">3</td>
|
||
<td style="text-align:left">extension to be used for dest files.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
<h2 id="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 is a link to 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 is a link to <a href="https://example.com" rel="external" target="_self">https://example.com</a>.</p>
|
||
</div>
|
||
</div>
|
||
<h3 id="basic-link">Basic Link</h3>
|
||
<p>You can explicitly define links in case you want to use non-absolute URLs or want to give different text.</p>
|
||
<div class="highlight 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 with Tooltip</h3>
|
||
<p>For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.</p>
|
||
<div class="highlight 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 for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.</p>
|
||
<div class="highlight 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 to 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 to 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-markdown"></i></span><span class="badge-content" style="background-color: #888cc4;">PHP</span></span> Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.</p>
|
||
<p>Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.</p>
|
||
<p>Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.</p>
|
||
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">That's some text with a footnote[^1]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[^1]: And that's the footnote.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">That's some more text with a footnote.[^someid]
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl">[^someid]:
|
||
</span></span><span class="line"><span class="cl"> Anything of interest goes here.
|
||
</span></span><span class="line"><span class="cl">
|
||
</span></span><span class="line"><span class="cl"> Blue light glows blue.</span></span></code></pre></div>
|
||
<div class="box notices cstyle code">
|
||
<div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div>
|
||
<div class="box-content">
|
||
|
||
<p>That’s some text with a footnote<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></p>
|
||
<p>That’s some more text with a footnote.<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></p>
|
||
<div class="footnotes" role="doc-endnotes">
|
||
<hr>
|
||
<ol>
|
||
<li id="fn:1">
|
||
<p>And that’s the footnote. <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
<li id="fn:2">
|
||
<p>Anything of interest goes here.</p>
|
||
<p>Blue light glows blue. <a href="#fnref:2" class="footnote-backref" role="doc-backlink">↩︎</a></p>
|
||
</li>
|
||
</ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 id="images">Images</h2>
|
||
<h3 id="basic-images">Basic Images</h3>
|
||
<p>Images have a similar syntax to links but include a preceding exclamation mark.</p>
|
||
<div class="highlight 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-1e9b9312c7627507a79393bea83a0c7f" 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-1e9b9312c7627507a79393bea83a0c7f"><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 with 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-d417f9ebbe298251315f5c2e97cb4433" 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-d417f9ebbe298251315f5c2e97cb4433"><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 to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.</p>
|
||
<div class="highlight 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-0cda45eac12c0c62b7342868df6b49b0" 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-0cda45eac12c0c62b7342868df6b49b0"><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;">Relearn</span></span> This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default <a href="/hugo-theme-relearn/cont/imageeffects/index.html">behavior is configurable</a> through your <code>hugo.toml</code> or frontmatter parameter.</p>
|
||
<h4 id="resizing">Resizing</h4>
|
||
<p>Add query parameter <code>width</code> and/or <code>height</code> to the link image to resize the image. Values are CSS values (default is <code>auto</code>).</p>
|
||
<div class="highlight 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-15a096bef65544ad5a8b11648b93ff66" 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-15a096bef65544ad5a8b11648b93ff66"><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-df41fa55fe8548590bddd1c8581501a2" 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-df41fa55fe8548590bddd1c8581501a2"><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-bb2a3f1fa50298d3b24c8a298915b4f0" 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-bb2a3f1fa50298d3b24c8a298915b4f0"><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> to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.</p>
|
||
<h5 id="shadow">Shadow</h5>
|
||
<div class="highlight 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-51c9478b8ef0d433af3d21e60b76886a" 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-51c9478b8ef0d433af3d21e60b76886a"><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-d47c7890987b51f0ca14dc9e61d1195f" 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-d47c7890987b51f0ca14dc9e61d1195f"><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-09164105cc71a6e6376b2ac041e0ac6d" 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-09164105cc71a6e6376b2ac041e0ac6d"><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-3b748f2f2bb6ee751194b9a4265678f1" 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-3b748f2f2bb6ee751194b9a4265678f1"><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-125dc8ff9a2c1d3ae9d7794f8c717cfb" 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-125dc8ff9a2c1d3ae9d7794f8c717cfb"><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-09021e877b07cb539175096d90b8743f" 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-09021e877b07cb539175096d90b8743f"><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-44831261070dfad925b96b9f9d07bb56" 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-44831261070dfad925b96b9f9d07bb56"><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-53eb6965b02f93aade55f2c40588cc13" 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-53eb6965b02f93aade55f2c40588cc13"><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">Combination</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-412fce790fa869fd7f9f5462e3163ab0" 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-412fce790fa869fd7f9f5462e3163ab0"><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 the query parameter <code>lightbox=false</code> to the image link to disable the 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> Note</div>
|
||
<div class="box-content">
|
||
|
||
<p>If you want to wrap an image in a link and <code>lightbox=true</code> is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your 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">
|
||
</footer>
|
||
</article>
|
||
|
||
</div>
|
||
</main>
|
||
</div>
|
||
<script src="/hugo-theme-relearn/js/clipboard.min.js?1723555287" defer></script>
|
||
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1723555287" defer></script>
|
||
<script src="/hugo-theme-relearn/js/theme.js?1723555287" defer></script>
|
||
</body>
|
||
</html>
|