<!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.123.8"> <meta name="generator" content="Relearn 5.25.0+tip"> <meta name="description" content="Nice icons for your page"> <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="Icon :: Hugo Relearn Theme"> <meta name="twitter:description" content="Nice icons for your page"> <meta property="og:title" content="Icon :: Hugo Relearn Theme"> <meta property="og:description" content="Nice icons for your page"> <meta property="og:type" content="article"> <meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon/index.html"> <meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png"> <meta property="article:section" content="Shortcodes :: Hugo Relearn Theme"> <meta property="og:site_name" content="Hugo Relearn Theme"> <title>Icon :: Hugo Relearn Theme</title> <link href="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon/index.html" rel="alternate" hreflang="x-default"> <link href="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/icon/index.html" rel="alternate" hreflang="en"> <link href="https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/icon/index.html" rel="alternate" hreflang="art-pir"> <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="/hugo-theme-relearn/shortcodes/icon/index.xml" rel="alternate" type="application/rss+xml" title="Icon :: Hugo Relearn Theme"> <link href="/hugo-theme-relearn/images/logo.svg?1710192527" rel="icon" type="image/svg+xml"> <!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how-to-use --> <link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1710192528" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1710192528" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/nucleus.css?1710192528" rel="stylesheet"> <link href="/hugo-theme-relearn/css/auto-complete.css?1710192528" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1710192528" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1710192528" rel="stylesheet"> <link href="/hugo-theme-relearn/css/fonts.css?1710192528" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1710192528" rel="stylesheet"></noscript> <link href="/hugo-theme-relearn/css/theme.css?1710192528" rel="stylesheet"> <link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1710192528" rel="stylesheet" id="R-variant-style"> <link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1710192528" rel="stylesheet" id="R-variant-chroma-style"> <link href="/hugo-theme-relearn/css/variant.css?1710192528" rel="stylesheet"> <link href="/hugo-theme-relearn/css/print.css?1710192528" rel="stylesheet" media="print"> <link href="/hugo-theme-relearn/css/format-print.css?1710192528" rel="stylesheet"> <link href="/hugo-theme-relearn/css/ie.css?1710192528" rel="stylesheet"> <script src="/hugo-theme-relearn/js/url.js?1710192528"></script> <script src="/hugo-theme-relearn/js/variant.js?1710192528"></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="/hugo-theme-relearn/index.search.js"; var root_url="/"; var baseUri=root_url.replace(/\/$/, ''); window.relearn = window.relearn || {}; window.relearn.baseUriFull='https:\/\/mcshelby.github.io\/hugo-theme-relearn/'; // variant stuff window.relearn.themeVariantModifier=''; window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] ); // translations window.T_Copy_to_clipboard = `Copy 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/shortcodes/icon/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/shortcodes/index.html"><span itemprop="name">Shortcodes</span></a><meta itemprop="position" content="1"> > </li><li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Icon</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"> </header> <h1 id="icon">Icon</h1> <p>The <code>icon</code> shortcode displays icons using the <a href="https://fontawesome.com" target="_blank">Font Awesome</a> library.</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" data-tab-group="shortcode-parameter"> <div class="tab-nav"> <div class="tab-nav-title">​</div> <button data-tab-item="shortcode" class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1" onclick="switchTab('shortcode-parameter','shortcode')" > <span class="tab-nav-text">shortcode</span> </button> <button data-tab-item="shortcode-positional" class="tab-nav-button tab-panel-style cstyle initial" onclick="switchTab('shortcode-parameter','shortcode-positional')" > <span class="tab-nav-text">shortcode (positional)</span> </button> <button data-tab-item="partial" class="tab-nav-button tab-panel-style cstyle initial" onclick="switchTab('shortcode-parameter','partial')" > <span class="tab-nav-text">partial</span> </button> </div> <div class="tab-content-container"> <div data-tab-item="shortcode" class="tab-content tab-panel-style cstyle initial active"> <div class="tab-content-text"> <div class="highlight wrap-code"><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> <div data-tab-item="shortcode-positional" class="tab-content tab-panel-style cstyle initial"> <div class="tab-content-text"> <div class="highlight wrap-code"><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> <div data-tab-item="partial" class="tab-content tab-panel-style cstyle initial"> <div class="tab-content-text"> <div class="highlight wrap-code"><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">"page"</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">"page"</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">"page"</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> </div> <h3 id="parameter">Parameter</h3> <table> <thead> <tr> <th>Name</th> <th>Position</th> <th>Default</th> <th>Notes</th> </tr> </thead> <tbody> <tr> <td><strong>icon</strong></td> <td>1</td> <td><em><empty></em></td> <td><a href="/hugo-theme-relearn/shortcodes/icon/index.html#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" target="_blank">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" target="_blank">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" target="_blank">web fonts with CSS</a> for more.</p> <h2 id="examples">Examples</h2> <h3 id="standard-usage">Standard Usage</h3> <div class="highlight wrap-code"><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 simplifies using standard icons, the icon customization and other advanced features of the Font Awesome library require you to use HTML directly. Paste the <code><i></code> HTML into markup, and Font Awesome will load the relevant icon.</p> <div class="highlight wrap-code"><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> <p>To use these native HTML elements in your Markdown, add this in your <code>hugo.toml</code>:</p> <div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">markup</span><span class="p">.</span><span class="nx">goldmark</span><span class="p">.</span><span class="nx">renderer</span><span class="p">]</span> </span></span><span class="line"><span class="cl"> <span class="nx">unsafe</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div> <footer class="footline"> </footer> </article> </div> </main> </div> <script src="/hugo-theme-relearn/js/clipboard.min.js?1710192528" defer></script> <script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1710192528" defer></script> <script src="/hugo-theme-relearn/js/theme.js?1710192528" defer></script> </body> </html>