<!DOCTYPE html> <html lang="en" dir="ltr"> <head> <meta charset="utf-8"> <meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0"> <meta name="generator" content="Hugo 0.119.0"> <meta name="generator" content="Relearn 5.22.1+tip"> <meta name="description" content="Documentation for Hugo Relearn Theme"> <meta name="author" content="Sören Weber"> <meta name="twitter:card" content="summary_large_image"> <meta name="twitter:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png"> <meta name="twitter:title" content="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. Markdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it. Some of the key benefits are: Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content. Less chance of errors when writing in Markdown."> <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. Markdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it. Some of the key benefits are: Markdown is simple to learn, with minimal extra characters so it’s also quicker to write content. Less chance of errors when writing in Markdown."> <meta property="og:type" content="article"> <meta property="og:url" content="https://McShelby.github.io/hugo-theme-relearn/cont/markdown/index.html"> <meta property="og:image" content="https://McShelby.github.io/hugo-theme-relearn/images/hero.png"> <meta property="article:section" content="Content :: Hugo Relearn Theme"> <meta property="og:site_name" content="Hugo Relearn Theme"> <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="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="../../cont/markdown/index.xml" rel="alternate" type="application/rss+xml" title="Markdown syntax :: Hugo Relearn Theme"> <link href="../../images/logo.svg?1698349360" rel="icon" type="image/svg+xml"> <!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use --> <link href="../../css/fontawesome-all.min.css?1698349362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1698349362" rel="stylesheet"></noscript> <link href="../../css/nucleus.css?1698349362" rel="stylesheet"> <link href="../../css/auto-complete.css?1698349362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1698349362" rel="stylesheet"></noscript> <link href="../../css/perfect-scrollbar.min.css?1698349362" rel="stylesheet"> <link href="../../css/fonts.css?1698349362" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1698349362" rel="stylesheet"></noscript> <link href="../../css/theme.css?1698349362" rel="stylesheet"> <link href="../../css/theme-auto.css?1698349362" rel="stylesheet" id="R-variant-style"> <link href="../../css/variant.css?1698349362" rel="stylesheet"> <link href="../../css/print.css?1698349362" rel="stylesheet" media="print"> <link href="../../css/format-print.css?1698349362" rel="stylesheet"> <link href="../../css/ie.css?1698349362" rel="stylesheet"> <script src="../../js/url.js?1698349362"></script> <script src="../../js/variant.js?1698349362"></script> <script> // hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic: // https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72 window.index_js_url="../../index.search.js"; var root_url="../../"; var baseUri=root_url.replace(/\/$/, ''); // translations window.T_Copy_to_clipboard = 'Copy to clipboard'; window.T_Copied_to_clipboard = 'Copied to clipboard!'; window.T_Copy_link_to_clipboard = 'Copy link to clipboard'; window.T_Link_copied_to_clipboard = 'Copied link to clipboard!'; window.T_Reset_view = 'Reset view'; window.T_View_reset = 'View reset!'; window.T_No_results_found = 'No results found for \u0022{0}\u0022'; window.T_N_results_found = '{1} results found for \u0022{0}\u0022'; // some further base stuff var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/'; window.variants && variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] ); </script> <style> #R-body img.bg-white { background-color: white; } </style> </head> <body class="mobile-support print disableInlineCopyToClipboard" data-url="../../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="../../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> </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="../../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> <p>Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:</p> <div class="box notices cstyle tip"> <div class="box-label"><i class="fa-fw fas fa-lightbulb"></i> Tip</div> <div class="box-content"> <p><i class="fa-fw fas fa-bookmark"></i> Bookmark this page and the <a href="https://commonmark.org/help/" target="_blank">official Commonmark reference</a> for easy future reference!</p> </div> </div> <h2 id="paragraphs">Paragraphs</h2> <p>In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.</p> <p>Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.</p> <p>Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p> </div> </div> <h2 id="headings">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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="gh"># h1 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 secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <h1 id="h1-heading">h1 Heading</h1> <h2 id="h2-heading">h2 Heading</h2> <h3 id="h3-heading">h3 Heading</h3> <h4 id="h4-heading">h4 Heading</h4> <h5 id="h5-heading">h5 Heading</h5> <h6 id="h6-heading">h6 Heading</h6> </div> </div> <h2 id="horizontal-rules">Horizontal Rules</h2> <p>To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes <code>---</code>.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">--- </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.</p> <hr> <p>Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.</p> </div> </div> <h2 id="text-markers">Text Markers</h2> <h3 id="bold">Bold</h3> <p>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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">I am rendered with **bold text**</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p>I am rendered 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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">I am rendered with _italicized text_</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p>I am rendered with <em>italicized text</em></p> </div> </div> <h3 id="strikethrough">Strikethrough</h3> <p>In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes <code>~~</code>.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">~~Strike through this text~~</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><del>Strike through this text</del></p> </div> </div> <h2 id="text-substitution">Text substitution</h2> <p>This Markdown dialect supports an extension to combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Double quotes <span class="sb">`"`</span> and single quotes <span class="sb">`'`</span> of enclosed text are replaced by <span class="ge">**</span>"double curly quotes"** and <span class="ge">**</span>'single curly quotes'**. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">Double dashes <span class="sb">`--`</span> and triple dashes <span class="sb">`---`</span> are replaced by en-dash <span class="ge">**</span>--** and em-dash <span class="ge">**</span>---** entities. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">Double arrows pointing left <span class="sb">`<<`</span> or right <span class="sb">`>>`</span> are replaced by arrow <span class="ge">**</span><span class="err"><<</span>** and <span class="ge">**</span>>>** entities. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">Three consecutive dots <span class="sb">`...`</span> are replaced by an ellipsis <span class="ge">**</span>...** entity.</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p>Double quotes <code>"</code> and single quotes <code>'</code> of enclosed text are replaced by <strong>“double curly quotes”</strong> and <strong>‘single curly quotes’</strong>.</p> <p>Double dashes <code>--</code> and triple dashes <code>---</code> are replaced by en-dash <strong>–</strong> and em-dash <strong>—</strong> entities.</p> <p>Double arrows pointing left <code><<</code> or right <code>>></code> are replaced by arrow <strong>«</strong> and <strong>»</strong> entities.</p> <p>Three consecutive dots <code>...</code> are replaced by an ellipsis <strong>…</strong> entity.</p> </div> </div> <h2 id="lists">Lists</h2> <h3 id="unordered">Unordered</h3> <p>You can write a list of items in which the order of the items does not explicitly matter.</p> <p>It is possible to nest lists by indenting an item for the next sublevel.</p> <p>You may use any of <code>-</code>, <code>*</code> or <code>+</code> to denote bullets for each list item but should not switch between those symbols inside one whole list.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">-</span> Lorem ipsum dolor sit amet </span></span><span class="line"><span class="cl"><span class="k">-</span> Consectetur 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 secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <ul> <li>Lorem ipsum dolor sit amet</li> <li>Consectetur adipiscing elit <ul> <li>Vestibulum laoreet porttitor sem</li> <li>Ac tristique libero volutpat at</li> </ul> </li> <li>Nulla volutpat aliquam velit <ul> <li>Phasellus iaculis neque</li> <li>Purus sodales ultricies</li> </ul> </li> <li>Faucibus porta lacus fringilla vel</li> </ul> </div> </div> <h3 id="ordered">Ordered</h3> <p>You can create a list of items in which the order of items does explicitly matter.</p> <p>It is possible to nest lists by indenting an item for the next sublevel.</p> <p>Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">1.</span> Lorem ipsum dolor sit amet </span></span><span class="line"><span class="cl"><span class="k">3.</span> Consectetur 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 secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <ol> <li>Lorem ipsum dolor sit amet</li> <li>Consectetur adipiscing elit <ol> <li>Integer molestie lorem at massa</li> <li>Facilisis in pretium nisl aliquet</li> </ol> </li> <li>Nulla volutpat aliquam velit <ol> <li>Faucibus porta lacus fringilla vel</li> <li>Aenean sit amet erat nunc</li> </ol> </li> <li>Eget porttitor lorem</li> </ol> </div> </div> <h3 id="tasks">Tasks</h3> <p>In GFM (GitHub Flavored Markdown) you can add task lists resulting in checked or unchecked non-clickable items</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">- [x]</span> Basic Test </span></span><span class="line"><span class="cl"><span class="k">- [ ]</span> More Tests </span></span><span class="line"><span class="cl"> <span class="k">- [x]</span> View </span></span><span class="line"><span class="cl"> <span class="k">- [x]</span> Hear </span></span><span class="line"><span class="cl"> - [ ] Smell</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <ul> <li><input checked="" disabled="" type="checkbox"> Basic Test</li> <li><input disabled="" type="checkbox"> More Tests <ul> <li><input checked="" disabled="" type="checkbox"> View</li> <li><input checked="" disabled="" type="checkbox"> Hear</li> <li><input disabled="" type="checkbox"> Smell</li> </ul> </li> </ul> </div> </div> <h3 id="definitions">Definitions</h3> <p>This Markdown dialect supports an extension to add definition lists. Definition lists are made of terms and definitions of these terms, much like in a dictionary.</p> <p>A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.</p> <p>If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Apple </span></span><span class="line"><span class="cl">: Pomaceous fruit of plants of the genus Malus in the family Rosaceae. </span></span><span class="line"><span class="cl">: An American computer company. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">Orange </span></span><span class="line"><span class="cl">: The fruit of an evergreen tree of the genus Citrus. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"> You can make juice out of it. </span></span><span class="line"><span class="cl">: A telecommunication company. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"> You can't make juice out of it.</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <dl> <dt>Apple</dt> <dd>Pomaceous fruit of plants of the genus Malus in the family Rosaceae.</dd> <dd>An American computer company.</dd> <dt>Orange</dt> <dd>The fruit of an evergreen tree of the genus Citrus. <p>You can make juice out of it.</p> </dd> <dd>A telecommunication company. <p>You can’t make juice out of it.</p> </dd> </dl> </div> </div> <h2 id="code">Code</h2> <h3 id="inline-code">Inline Code</h3> <p>Inline snippets of code can be wrapped with backticks <code>`</code>.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">In this example, <span class="sb">`<div></div>`</span> is marked as code.</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p>In this example, <code><div></div></code> is marked as code.</p> </div> </div> <h3 id="indented-code-block">Indented Code Block</h3> <p>A simple code block can be generated by indenting several lines of code by at least two spaces.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">Be impressed by my advanced code: </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"> // Some comments </span></span><span class="line"><span class="cl"> line 1 of code </span></span><span class="line"><span class="cl"> line 2 of code </span></span><span class="line"><span class="cl"> line 3 of code</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p>Be impressed by my advanced code:</p> <pre><code>// Some comments line 1 of code line 2 of code line 3 of code </code></pre> </div> </div> <h3 id="fenced-code-block">Fenced Code Block</h3> <p>If you want to gain more control of your code block you can enclose your code by at least three backticks <code>```</code> a so called fence.</p> <p>In GFM (GitHub Flavored Markdown) you can also add a language specifier directly after the opening fence, <code>```js</code>, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.</p> <p>See <a href="../../shortcodes/highlight/index.html">Code Highlighting</a> for additional documentation.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-plaintext" data-lang="plaintext"><span class="line"><span class="cl">```js </span></span><span class="line"><span class="cl">grunt.initConfig({ </span></span><span class="line"><span class="cl"> assemble: { </span></span><span class="line"><span class="cl"> options: { </span></span><span class="line"><span class="cl"> assets: 'docs/assets', </span></span><span class="line"><span class="cl"> data: 'src/data/*.{json,yml}', </span></span><span class="line"><span class="cl"> helpers: 'src/custom-helpers.js', </span></span><span class="line"><span class="cl"> partials: ['src/partials/**/*.{hbs,md}'] </span></span><span class="line"><span class="cl"> }, </span></span><span class="line"><span class="cl"> pages: { </span></span><span class="line"><span class="cl"> options: { </span></span><span class="line"><span class="cl"> layout: 'default.hbs' </span></span><span class="line"><span class="cl"> }, </span></span><span class="line"><span class="cl"> files: { </span></span><span class="line"><span class="cl"> './': ['src/templates/pages/index.hbs'] </span></span><span class="line"><span class="cl"> } </span></span><span class="line"><span class="cl"> } </span></span><span class="line"><span class="cl"> } </span></span><span class="line"><span class="cl">}; </span></span><span class="line"><span class="cl">```</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-js" data-lang="js"><span class="line"><span class="cl"><span class="nx">grunt</span><span class="p">.</span><span class="nx">initConfig</span><span class="p">({</span> </span></span><span class="line"><span class="cl"> <span class="nx">assemble</span><span class="o">:</span> <span class="p">{</span> </span></span><span class="line"><span class="cl"> <span class="nx">options</span><span class="o">:</span> <span class="p">{</span> </span></span><span class="line"><span class="cl"> <span class="nx">assets</span><span class="o">:</span> <span class="s1">'docs/assets'</span><span class="p">,</span> </span></span><span class="line"><span class="cl"> <span class="nx">data</span><span class="o">:</span> <span class="s1">'src/data/*.{json,yml}'</span><span class="p">,</span> </span></span><span class="line"><span class="cl"> <span class="nx">helpers</span><span class="o">:</span> <span class="s1">'src/custom-helpers.js'</span><span class="p">,</span> </span></span><span class="line"><span class="cl"> <span class="nx">partials</span><span class="o">:</span> <span class="p">[</span><span class="s1">'src/partials/**/*.{hbs,md}'</span><span class="p">]</span> </span></span><span class="line"><span class="cl"> <span class="p">},</span> </span></span><span class="line"><span class="cl"> <span class="nx">pages</span><span class="o">:</span> <span class="p">{</span> </span></span><span class="line"><span class="cl"> <span class="nx">options</span><span class="o">:</span> <span class="p">{</span> </span></span><span class="line"><span class="cl"> <span class="nx">layout</span><span class="o">:</span> <span class="s1">'default.hbs'</span> </span></span><span class="line"><span class="cl"> <span class="p">},</span> </span></span><span class="line"><span class="cl"> <span class="nx">files</span><span class="o">:</span> <span class="p">{</span> </span></span><span class="line"><span class="cl"> <span class="s1">'./'</span><span class="o">:</span> <span class="p">[</span><span class="s1">'src/templates/pages/index.hbs'</span><span class="p">]</span> </span></span><span class="line"><span class="cl"> <span class="p">}</span> </span></span><span class="line"><span class="cl"> <span class="p">}</span> </span></span><span class="line"><span class="cl"> <span class="p">}</span> </span></span><span class="line"><span class="cl"><span class="p">};</span></span></span></code></pre></div></div> </div> <h2 id="tables">Tables</h2> <p>In GFM (GitHub Flavored Markdown) you can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">| Option | Description | </span></span><span class="line"><span class="cl">|--------|-------------| </span></span><span class="line"><span class="cl">| data | path to data files to supply the data that will be passed into templates. | </span></span><span class="line"><span class="cl">| engine | engine to be used for processing templates. Handlebars is the default. | </span></span><span class="line"><span class="cl">| ext | extension to be used for dest files. |</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <table> <thead> <tr> <th>Option</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>data</td> <td>path to data files to supply the data that will be passed into templates.</td> </tr> <tr> <td>engine</td> <td>engine to be used for processing templates. Handlebars is the default.</td> </tr> <tr> <td>ext</td> <td>extension to be used for dest files.</td> </tr> </tbody> </table> </div> </div> <h3 id="aligned-columns">Aligned Columns</h3> <p>Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">| Option | Number | Description | </span></span><span class="line"><span class="cl">|-------:|:------:|:------------| </span></span><span class="line"><span class="cl">| data | 1 | path to data files to supply the data that will be passed into templates. | </span></span><span class="line"><span class="cl">| engine | 2 | engine to be used for processing templates. Handlebars is the default. | </span></span><span class="line"><span class="cl">| ext | 3 | extension to be used for dest files. |</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <table> <thead> <tr> <th style="text-align:right">Option</th> <th style="text-align:center">Number</th> <th style="text-align:left">Description</th> </tr> </thead> <tbody> <tr> <td style="text-align:right">data</td> <td style="text-align:center">1</td> <td style="text-align:left">path to data files to supply the data that will be passed into templates.</td> </tr> <tr> <td style="text-align:right">engine</td> <td style="text-align:center">2</td> <td style="text-align:left">engine to be used for processing templates. Handlebars is the default.</td> </tr> <tr> <td style="text-align:right">ext</td> <td style="text-align:center">3</td> <td style="text-align:left">extension to be used for dest files.</td> </tr> </tbody> </table> </div> </div> <h2 id="blockquotes">Blockquotes</h2> <p>For quoting blocks of content from another source within your document add <code>></code> before any text you want to quote.</p> <p>Blockquotes can also be nested.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"><span class="k">> </span><span class="ge">Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. </span></span></span><span class="line"><span class="cl"><span class="ge"></span><span class="k">> </span></span></span><span class="line"><span class="cl"><span class="k"></span><span class="ge">> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam. </span></span></span><span class="line"><span class="cl"><span class="ge"></span>> </span></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 secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <blockquote> <p>Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.</p> <blockquote> <p>Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.</p> </blockquote> <p>Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</p> </blockquote> </div> </div> <h2 id="links">Links</h2> <h3 id="autolink">Autolink</h3> <p>In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">This is a link to https://example.com.</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p>This is a link to <a href="https://example.com" target="_blank">https://example.com</a>.</p> </div> </div> <h3 id="basic-link">Basic Link</h3> <p>You can explicitly define links in case you want to use non-absolute URLs or want to give different text.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">[<span class="nt">Assemble</span>](<span class="na">http://assemble.io</span>)</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p> <a href="http://assemble.io" target="_blank">Assemble</a></p> </div> </div> <h3 id="link-with-tooltip">Link 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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">[<span class="nt">Upstage</span>](<span class="na">https://github.com/upstage/ "Visit Upstage!"</span>)</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p> <a href="https://github.com/upstage/" title="Visit Upstage!" target="_blank">Upstage</a></p> </div> </div> <h3 id="link-references">Link References</h3> <p>Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">[Example][somelinkID] </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">[somelinkID]: https://example.com "Go to example domain"</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p> <a href="https://example.com" title="Go to example domain" target="_blank">Example</a></p> </div> </div> <h3 id="footnotes">Footnotes</h3> <p>Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.</p> <p>Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.</p> <p>Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">That's some text with a footnote[^1] </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">[^1]: And that's the footnote. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">That's some more text with a footnote.[^someid] </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">[^someid]: </span></span><span class="line"><span class="cl"> Anything of interest goes here. </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"> Blue light glows blue.</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p>That’s some text with a footnote<sup id="fnref:1"><a href="#fn:1" class="footnote-ref" role="doc-noteref">1</a></sup></p> <p>That’s some more text with a footnote.<sup id="fnref:2"><a href="#fn:2" class="footnote-ref" role="doc-noteref">2</a></sup></p> <div class="footnotes" role="doc-endnotes"> <hr> <ol> <li id="fn:1"> <p>And that’s the footnote. <a href="#fnref:1" class="footnote-backref" role="doc-backlink">↩︎</a></p> </li> <li id="fn:2"> <p>Anything of interest goes here.</p> <p>Blue light glows blue. <a href="#fnref:2" class="footnote-backref" role="doc-backlink">↩︎</a></p> </li> </ol> </div> </div> </div> <h2 id="images">Images</h2> <h3 id="basic-images">Basic Images</h3> <p>Images have a similar syntax to links but include a preceding exclamation mark.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-0e4efe305550efafab02fbb2b6ff2dc0" class="lightbox-link"><img src="https://octodex.github.com/images/spocktocat.png?width=20vw" alt="Spock" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-0e4efe305550efafab02fbb2b6ff2dc0"><img src="https://octodex.github.com/images/spocktocat.png?width=20vw" alt="Spock" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p> </div> </div> <h3 id="image-with-tooltip">Image with Tooltip</h3> <p>Like links, images can also be given a tooltip.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-0f226fa46d9c31f5cf4b8f3abb522e8b" class="lightbox-link"><img src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt="Picard" title="Jean Luc Picard" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-0f226fa46d9c31f5cf4b8f3abb522e8b"><img src="https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt="Picard" title="Jean Luc Picard" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p> </div> </div> <h3 id="image-references">Image References</h3> <p>Images can also be linked by reference ID 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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">![La Forge][laforge] </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl">[laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"</span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-38648130871f153f0e5ea36334c6b03c" class="lightbox-link"><img src="https://octodex.github.com/images/trekkie.jpg?width=20vw" alt="La Forge" title="Geordi La Forge" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-38648130871f153f0e5ea36334c6b03c"><img src="https://octodex.github.com/images/trekkie.jpg?width=20vw" alt="La Forge" title="Geordi La Forge" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p> </div> </div> <h3 id="image-effects">Image Effects</h3> <p>This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default <a href="../../cont/imageeffects/index.html">behavior is configurable</a> thru your <code>config.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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-82aab0ee5b94d504b9218c3d8b3983e1" class="lightbox-link"><img src="https://octodex.github.com/images/minion.png?width=20vw" alt="Minion" class="figure-image bg-white border lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-82aab0ee5b94d504b9218c3d8b3983e1"><img src="https://octodex.github.com/images/minion.png?width=20vw" alt="Minion" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p> </div> </div> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-05cff688fd3f4ab0f2f06c56daf523a0" class="lightbox-link"><img src="https://octodex.github.com/images/minion.png?height=50px" alt="Minion" class="figure-image bg-white border lightbox noshadow" style="height: 50px; width: auto;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-05cff688fd3f4ab0f2f06c56daf523a0"><img src="https://octodex.github.com/images/minion.png?height=50px" alt="Minion" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p> </div> </div> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-ab9036f38cc633d7727e57f31b6207de" class="lightbox-link"><img src="https://octodex.github.com/images/minion.png?height=50px&width=40vw" alt="Minion" class="figure-image bg-white border lightbox noshadow" style="height: 50px; width: 40vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-ab9036f38cc633d7727e57f31b6207de"><img src="https://octodex.github.com/images/minion.png?height=50px&width=40vw" alt="Minion" class="lightbox-image bg-white border lightbox noshadow" loading="lazy"></a></p> </div> </div> <h4 id="css-classes">CSS Classes</h4> <p>Add a query parameter <code>classes</code> 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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-756c4f227d4e7a65be9dce9a0dde407b" class="lightbox-link"><img src="https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" alt="Spidertocat" class="figure-image bg-white border lightbox noborder shadow" style="height: auto; width: 20vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-756c4f227d4e7a65be9dce9a0dde407b"><img src="https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" alt="Spidertocat" class="lightbox-image bg-white border lightbox noborder shadow" loading="lazy"></a></p> </div> </div> <h5 id="border">Border</h5> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-bc9ab05036f807468a06bd879485a297" class="lightbox-link"><img src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" alt="DrOctocat" class="figure-image bg-white border lightbox noshadow noshadow" style="height: auto; width: 20vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-bc9ab05036f807468a06bd879485a297"><img src="https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" alt="DrOctocat" class="lightbox-image bg-white border lightbox noshadow noshadow" loading="lazy"></a></p> </div> </div> <h5 id="left">Left</h5> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-f374624186b2dd4ca18e05d2db613f3d" class="lightbox-link"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt="Supertocat" class="figure-image bg-white border left lightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-f374624186b2dd4ca18e05d2db613f3d"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt="Supertocat" class="lightbox-image bg-white border left lightbox noshadow" loading="lazy"></a></p> </div> </div> <h5 id="right">Right</h5> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-6673e85be35384d37d79ab6d13de5ffa" class="lightbox-link"><img src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt="Riddlocat" class="figure-image bg-white border lightbox right noshadow" style="height: auto; width: 20vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-6673e85be35384d37d79ab6d13de5ffa"><img src="https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt="Riddlocat" class="lightbox-image bg-white border lightbox right noshadow" loading="lazy"></a></p> </div> </div> <h5 id="inline">Inline</h5> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"> </span></span><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-d4c067777a94db126befa5fc96120ae7" class="lightbox-link"><img src="https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" alt="Spidertocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-d4c067777a94db126befa5fc96120ae7"><img src="https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" alt="Spidertocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a> <a href="#R-image-fe7e986e9483e9ad783766856961ce4f" class="lightbox-link"><img src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt="DrOctocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-fe7e986e9483e9ad783766856961ce4f"><img src="https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt="DrOctocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a> <a href="#R-image-be3d483fba472f8f3ae590df64041fb0" class="lightbox-link"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt="Supertocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-be3d483fba472f8f3ae590df64041fb0"><img src="https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt="Supertocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a> <a href="#R-image-ca795779ccbb2fc6f04097676338ddc1" class="lightbox-link"><img src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt="Riddlocat" class="figure-image bg-white border inline lightbox noshadow" style="height: auto; width: 10vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-ca795779ccbb2fc6f04097676338ddc1"><img src="https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt="Riddlocat" class="lightbox-image bg-white border inline lightbox noshadow" loading="lazy"></a></p> </div> </div> <h5 id="combination">Combination</h5> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><a href="#R-image-97eea995d6b439b83f26b3eabdb98091" class="lightbox-link"><img src="https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt="X-tocat" class="figure-image bg-white border left lightbox shadow" style="height: auto; width: 20vw;" loading="lazy"></a> <a href="javascript:history.back();" class="lightbox-back" id="R-image-97eea995d6b439b83f26b3eabdb98091"><img src="https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt="X-tocat" class="lightbox-image bg-white border left lightbox shadow" loading="lazy"></a></p> </div> </div> <h4 id="lightbox">Lightbox</h4> <p>Add the query parameter <code>lightbox=false</code> to the image link to disable the lightbox.</p> <div class="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl"></span></span></code></pre></div> <div class="box notices cstyle secondary"> <div class="box-label"><i class="fa-fw fas fa-eye"></i> Result</div> <div class="box-content"> <p><img src="https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" alt="Homercat" class="figure-image bg-white border nolightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></p> </div> </div> <div class="box notices cstyle note"> <div class="box-label"><i class="fa-fw fas fa-exclamation-circle"></i> 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="wrap-code highlight"><pre tabindex="0" class="chroma"><code class="language-markdown" data-lang="markdown"><span class="line"><span class="cl">[<span class="nt">](https://octodex.github.com/#homercat)</span></span></code></pre></div><p> <a href="https://octodex.github.com/#homercat" target="_blank"><img src="https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" alt="Homercat" class="figure-image bg-white border nolightbox noshadow" style="height: auto; width: 20vw;" loading="lazy"></a></p> </div> </div> <footer class="footline"> </footer> </article> </div> </main> </div> <script src="../../js/clipboard.min.js?1698349362" defer></script> <script src="../../js/perfect-scrollbar.min.js?1698349362" defer></script> <script src="../../js/theme.js?1698349362" defer></script> </body> </html>