2022-12-02 17:32:53 +00:00
<!DOCTYPE html>
< html lang = "pir" 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 = "Documentation for Hugo Relearn Theme" >
< meta name = "author" content = "Sören Weber" >
< title > Icon :: Cap' n Hugo Relearrrn Theme< / title >
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/icon/index.html" rel = "canonical" type = "text/html" title = "Icon :: Cap'n Hugo Relearrrn Theme" >
< link href = "../../../pir/shortcodes/icon/index.xml" rel = "alternate" type = "application/rss+xml" title = "Icon :: Cap'n Hugo Relearrrn Theme" >
2022-12-04 12:58:18 +00:00
< link href = "../../../images/logo.svg?1670158694" rel = "icon" type = "image/svg+xml" >
2022-12-02 17:32:53 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2022-12-04 12:58:18 +00:00
< link href = "../../../css/fontawesome-all.min.css?1670158696" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/fontawesome-all.min.css?1670158696" rel = "stylesheet" > < / noscript >
< link href = "../../../css/featherlight.min.css?1670158696" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/featherlight.min.css?1670158696" rel = "stylesheet" > < / noscript >
< link href = "../../../css/auto-complete.css?1670158696" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/auto-complete.css?1670158696" rel = "stylesheet" > < / noscript >
< link href = "../../../css/perfect-scrollbar.min.css?1670158696" rel = "stylesheet" >
< link href = "../../../css/nucleus.css?1670158696" rel = "stylesheet" >
< link href = "../../../css/fonts.css?1670158696" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../../css/fonts.css?1670158696" rel = "stylesheet" > < / noscript >
< link href = "../../../css/theme.css?1670158696" rel = "stylesheet" >
< link href = "../../../css/theme-relearn-light.css?1670158696" rel = "stylesheet" id = "variant-style" >
< link href = "../../../css/ie.css?1670158696" rel = "stylesheet" >
< link href = "../../../css/variant.css?1670158696" rel = "stylesheet" >
< link href = "../../../css/print.css?1670158696" rel = "stylesheet" media = "print" >
< link href = "../../../css/format-print.css?1670158696" rel = "stylesheet" >
< script src = "../../../js/url.js?1670158696" > < / script >
< script src = "../../../js/variant.js?1670158696" > < / script >
2022-12-02 17:32:53 +00:00
< 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="../../../pir/index.search.js";
var root_url="../../../";
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy t\u0027 clipboard';
window.T_Copied_to_clipboard = 'Copied t\u0027 clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link t\u0027 clipboard';
window.T_Link_copied_to_clipboard = 'Copied link t\u0027 clipboard!';
window.T_No_results_found = 'No rrresults found fer \u0022{0}\u0022';
window.T_N_results_found = '{1} rrresults found fer \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 >
2022-12-04 12:58:18 +00:00
< script src = "../../../js/jquery.min.js?1670158696" defer > < / script >
2022-12-02 17:32:53 +00:00
< style >
#body img.bg-white {
background-color: white;
}
< / style >
< / head >
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../../pir/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 = "../../../pir/index.html" > < span itemprop = "name" > Cap' n Hugo Relearrrn Theme< / span > < / a > < meta itemprop = "position" content = "1" > > < / li >
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < a itemprop = "item" href = "../../../pir/shortcodes/index.html" > < span itemprop = "name" > Shorrrtcodes< / 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 >
< div class = "box notices cstyle warning" >
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Arrr! Pirrrates< / div >
< div class = "box-content" >
2022-12-04 10:37:18 +00:00
< p > Fello' pirrates, be awarrre < b > some stuff may not work< / b > fer us in this trrranslat'n. Like < b > table of rrramblings< / b > , see'ng < b > Merrrmaids< / b > , do'ng < b > math or chemistrrry< / b > and stuff.< / p >
< / div >
2022-12-02 17:32:53 +00:00
< / div >
< p > Th' < code > ay'con< / code > shorrrtcode displays ay'cons 'n yer text.< / p >
< p > Th' theme uses th' < a href = "https://fontawesome.com" > < strong > Font Awesome< / strong > < / a > library, allow'n ye t' easily display any ay'con or logo avail'ble 'n th' Font Awesome free collect'n.< / 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 th' examples be us'n shorrrtcodes wit' positional parameter ye be free t' also call this shorrrtcode from yer 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 > shorrrtcode< / 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 > shorrrtcode (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" > ay'con< / span > < span class = "nx" > ay'con< / 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" > ay'con< / span > < span class = "nx" > ay'con< / 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" > ay'con< / span > < span class = "nx" > ay'con< / 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" > ay'con< / span > < span class = "nx" > exclamat'n< / 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" > ay'con< / span > < span class = "nx" > angle< / span > < span class = "o" > -< / span > < span class = "nx" > do'ble< / 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" > ay'con< / 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" > Posit'n< / 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 > ay'con< / 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 ay'con name< / a > t' be displayed. It will be displayed 'n th' text color o' its accord'n context.< / td >
< / tr >
< / tbody >
< / table >
2022-12-02 18:27:40 +00:00
< h3 id = "finding-an-icon" > Find'n an ay'con< / h3 >
2022-12-02 17:32:53 +00:00
< p > Browse through th' avail'ble ay'cons 'n th' < a href = "https://fontawesome.com/v5/search?m=free" > Font Awesome Gallery< / a > . Notice that th' < strong > free< / strong > filter be enabled, as only th' free ay'cons be avail'ble by default.< / p >
< p > Once on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' < a href = "https://fontawesome.com/v5/icons/heart?s=solid" > heart< / a > , copy th' ay'con name an' paste into th' Marrrkdown rrrambl'n.< / p >
2022-12-02 18:27:40 +00:00
< h3 id = "customising-icons" > Customis'n Ay'cons< / h3 >
2022-12-02 17:32:53 +00:00
< p > Font Awesome provides many ways t' modify th' ay'con< / p >
< ul >
< li > Change color (by default th' ay'con will inherit th' parent color)< / li >
< li > Increase or decrease size< / li >
< li > Rotate< / li >
< li > Combine wit' other ay'cons< / li >
< / ul >
< p > Check th' full documentat'n on < a href = "https://fontawesome.com/how-to-use/web-fonts-with-css" > web fonts wit' CSS< / a > fer more.< / p >
< h2 id = "examples" > Examples< / h2 >
2022-12-02 18:27:40 +00:00
< h3 id = "standard-usage" > Standard Usage< / h3 >
2022-12-02 17:32:53 +00:00
< 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" > wit'< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > ay'con< / span > < span class = "nx" > heart< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > by< / span > < span class = "nx" > Relearrrn< / span > < span class = "nx" > an'< / span > < span class = "nx" > Cap'n Hugo< / span >
< / span > < / span > < / code > < / pre > < / div > < p > Built wit'
< i class = "fa-fw fas fa-heart" > < / i > by Relearrrn an' Cap'n Hugo< / p >
< h3 id = "advanced-html-usage" > Advanced HTML Usage< / h3 >
< p > While th' shorrrtcode simplyfies us'n standard ay'cons, th' ay'con customisat'n an' other advanced features o' th' Font Awesome library requires ye t' use HTML directly. Just paste th' < code > < i> < / code > HTML into marrrkup an' Font Awesome will board th' relevant ay'con.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-html" data-lang = "html" > < span class = "line" > < span class = "cl" > Built wit' < 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 Relearrrn an' Cap'n Hugo
< / span > < / span > < / code > < / pre > < / div > < p > Built wit' < i class = "fas fa-heart" > < / i > by Relearrrn an' Cap'n Hugo< / p >
< footer class = "footline" >
< / footer >
< / article >
< / div >
< / main >
< / div >
2022-12-04 12:58:18 +00:00
< script src = "../../../js/clipboard.min.js?1670158696" defer > < / script >
< script src = "../../../js/perfect-scrollbar.min.js?1670158696" defer > < / script >
< script src = "../../../js/featherlight.min.js?1670158696" defer > < / script >
< script src = "../../../js/theme.js?1670158696" defer > < / script >
2022-12-02 17:32:53 +00:00
< / body >
< / html >
