<!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.107.0"> <meta name="generator" content="Relearn 5.7.0+tip"> <meta name="description" content="Nice icons for your page"> <meta name="author" content="Sören Weber"> <title>Icon :: Hugo Relearn Theme</title> <link href="https://McShelby.github.io/hugo-theme-relearn/shortcodes/icon/index.html" rel="canonical" type="text/html" title="Icon :: Hugo Relearn Theme"> <link href="../../shortcodes/icon/index.xml" rel="alternate" type="application/rss+xml" title="Icon :: Hugo Relearn Theme"> <link href="../../images/logo.svg?1670010345" 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?1670010346" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fontawesome-all.min.css?1670010346" rel="stylesheet"></noscript> <link href="../../css/featherlight.min.css?1670010346" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/featherlight.min.css?1670010346" rel="stylesheet"></noscript> <link href="../../css/auto-complete.css?1670010346" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/auto-complete.css?1670010346" rel="stylesheet"></noscript> <link href="../../css/perfect-scrollbar.min.css?1670010346" rel="stylesheet"> <link href="../../css/nucleus.css?1670010346" rel="stylesheet"> <link href="../../css/fonts.css?1670010346" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="../../css/fonts.css?1670010346" rel="stylesheet"></noscript> <link href="../../css/theme.css?1670010346" rel="stylesheet"> <link href="../../css/theme-relearn-light.css?1670010346" rel="stylesheet" id="variant-style"> <link href="../../css/ie.css?1670010346" rel="stylesheet"> <link href="../../css/variant.css?1670010346" rel="stylesheet"> <link href="../../css/print.css?1670010346" rel="stylesheet" media="print"> <link href="../../css/format-print.css?1670010346" rel="stylesheet"> <script src="../../js/url.js?1670010346"></script> <script src="../../js/variant.js?1670010346"></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_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( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] ); </script> <script src="../../js/jquery.min.js?1670010346" defer></script> <style> #body img.bg-white { background-color: white; } </style> </head> <body class="mobile-support print disableInlineCopyToClipboard" data-url="../../shortcodes/icon/index.html"> <div id="body" class="default-animation"> <div id="sidebar-overlay"></div> <div id="toc-overlay"></div> <nav id="topbar" class="highlightable" dir="ltr"> <div> <div id="breadcrumbs"> <span id="sidebar-toggle-span"> <a href="#" id="sidebar-toggle" title='Menu (CTRL+ALT+n)'><i class="fas fa-bars fa-fw"></i></a> </span> <ol class="links" itemscope itemtype="http://schema.org/BreadcrumbList"> <li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../index.html"><span itemprop="name">Hugo Relearn Theme</span></a><meta itemprop="position" content="1"> > </li> <li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="../../shortcodes/index.html"><span itemprop="name">Shortcodes</span></a><meta itemprop="position" content="2"> > </li> <li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Icon</span><meta itemprop="position" content="3"></li> </ol> </div> </div> </nav> <main id="body-inner" class="highlightable default" tabindex="-1"> <div class="flex-block-wrapper"> <div id="head-tags"> </div> <article class="default"> <h1 id="icon">Icon</h1> <p>The <code>icon</code> shortcode displays icons in your text.</p> <p>The theme uses the <a href="https://fontawesome.com"><strong>Font Awesome</strong></a> library, allowing you to easily display any icon or logo available in the Font Awesome free collection.</p> <p> <i class="fa-fw fas fa-exclamation-triangle"></i> <i class="fa-fw fas fa-angle-double-up"></i> <i class="fa-fw fas fa-skull-crossbones"></i></p> <h2 id="usage">Usage</h2> <p>While the examples are using shortcodes with positional parameter you are free to also call this shortcode from your own partials.</p> <div class="tab-panel"> <div class="tab-nav"> <button data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-nav-button direction-ltr active" onclick="switchTab('shortcode-parameter','shortcode')" ><span>shortcode</span></button> <button data-tab-item="shortcode (positional)" data-tab-group="shortcode-parameter" class="tab-nav-button direction-ltr " onclick="switchTab('shortcode-parameter','shortcode (positional)')" ><span>shortcode (positional)</span></button> <button data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-nav-button direction-ltr " onclick="switchTab('shortcode-parameter','partial')" ><span>partial</span></button> </div> <div class="tab-content"> <div data-tab-item="shortcode" data-tab-group="shortcode-parameter" class="tab-item active"> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"exclamation-triangle"</span> <span class="o">%</span><span class="p">}}</span> </span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"angle-double-up"</span> <span class="o">%</span><span class="p">}}</span> </span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">icon</span><span class="p">=</span><span class="s">"skull-crossbones"</span> <span class="o">%</span><span class="p">}}</span> </span></span></code></pre></div> </div> <div data-tab-item="shortcode (positional)" data-tab-group="shortcode-parameter" class="tab-item "> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">exclamation</span><span class="o">-</span><span class="nx">triangle</span> <span class="o">%</span><span class="p">}}</span> </span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">angle</span><span class="o">-</span><span class="nx">double</span><span class="o">-</span><span class="nx">up</span> <span class="o">%</span><span class="p">}}</span> </span></span><span class="line"><span class="cl"><span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">skull</span><span class="o">-</span><span class="nx">crossbones</span> <span class="o">%</span><span class="p">}}</span> </span></span></code></pre></div> </div> <div data-tab-item="partial" data-tab-group="shortcode-parameter" class="tab-item "> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/icon.html"</span> <span class="p">(</span><span class="nx">dict</span> </span></span><span class="line"><span class="cl"> <span class="s">"context"</span> <span class="p">.</span> </span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"exclamation-triangle"</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 class="nx">partial</span> <span class="s">"shortcodes/icon.html"</span> <span class="p">(</span><span class="nx">dict</span> </span></span><span class="line"><span class="cl"> <span class="s">"context"</span> <span class="p">.</span> </span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"angle-double-up"</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 class="nx">partial</span> <span class="s">"shortcodes/icon.html"</span> <span class="p">(</span><span class="nx">dict</span> </span></span><span class="line"><span class="cl"> <span class="s">"context"</span> <span class="p">.</span> </span></span><span class="line"><span class="cl"> <span class="s">"icon"</span> <span class="s">"skull-crossbones"</span> </span></span><span class="line"><span class="cl"><span class="p">)}}</span> </span></span></code></pre></div> </div> </div> </div> <h3 id="parameter">Parameter</h3> <table> <thead> <tr> <th style="text-align:left">Name</th> <th style="text-align:left">Position</th> <th style="text-align:left">Default</th> <th style="text-align:left">Notes</th> </tr> </thead> <tbody> <tr> <td style="text-align:left"><strong>icon</strong></td> <td style="text-align:left">1</td> <td style="text-align:left"><em><empty></em></td> <td style="text-align:left"><a href="#finding-an-icon">Font Awesome icon name</a> to be displayed. It will be displayed in the text color of its according context.</td> </tr> </tbody> </table> <h3 id="finding-an-icon">Finding an icon</h3> <p>Browse through the available icons in the <a href="https://fontawesome.com/v5/search?m=free">Font Awesome Gallery</a>. Notice that the <strong>free</strong> filter is enabled, as only the free icons are available by default.</p> <p>Once on the Font Awesome page for a specific icon, for example the page for the <a href="https://fontawesome.com/v5/icons/heart?s=solid">heart</a>, copy the icon name and paste into the Markdown content.</p> <h3 id="customising-icons">Customising Icons</h3> <p>Font Awesome provides many ways to modify the icon</p> <ul> <li>Change color (by default the icon will inherit the parent color)</li> <li>Increase or decrease size</li> <li>Rotate</li> <li>Combine with other icons</li> </ul> <p>Check the full documentation on <a href="https://fontawesome.com/how-to-use/web-fonts-with-css">web fonts with CSS</a> for more.</p> <h2 id="examples">Examples</h2> <h3 id="standard-usage">Standard Usage</h3> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="nx">Built</span> <span class="nx">with</span> <span class="p">{{</span><span class="o">%</span> <span class="nx">icon</span> <span class="nx">heart</span> <span class="o">%</span><span class="p">}}</span> <span class="nx">by</span> <span class="nx">Relearn</span> <span class="nx">and</span> <span class="nx">Hugo</span> </span></span></code></pre></div><p>Built with <i class="fa-fw fas fa-heart"></i> by Relearn and Hugo</p> <h3 id="advanced-html-usage">Advanced HTML Usage</h3> <p>While the shortcode simplyfies using standard icons, the icon customisation and other advanced features of the Font Awesome library requires you to use HTML directly. Just paste the <code><i></code> HTML into markup and Font Awesome will load the relevant icon.</p> <div class="highlight"><pre tabindex="0" class="chroma"><code class="language-html" data-lang="html"><span class="line"><span class="cl">Built with <span class="p"><</span><span class="nt">i</span> <span class="na">class</span><span class="o">=</span><span class="s">"fas fa-heart"</span><span class="p">></</span><span class="nt">i</span><span class="p">></span> by Relearn and Hugo </span></span></code></pre></div><p>Built with <i class="fas fa-heart"></i> by Relearn and Hugo</p> <footer class="footline"> </footer> </article> </div> </main> </div> <script src="../../js/clipboard.min.js?1670010346" defer></script> <script src="../../js/perfect-scrollbar.min.js?1670010346" defer></script> <script src="../../js/featherlight.min.js?1670010346" defer></script> <script src="../../js/theme.js?1670010346" defer></script> </body> </html>