2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2022-11-01 01:10:49 +00:00
< html lang = "en" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2023-01-22 21:19:30 +00:00
< meta name = "generator" content = "Hugo 0.110.0" >
2023-02-24 23:35:56 +00:00
< meta name = "generator" content = "Relearn 5.12.0+tip" >
2022-04-02 13:30:16 +00:00
< meta name = "description" content = "Documentation for Hugo Relearn Theme" >
< meta name = "author" content = "Sören Weber" >
< title > Shortcodes :: Hugo Relearn Theme< / title >
2023-01-25 11:42:06 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/shortcodes/index.html" rel = "alternate" hreflang = "pir" >
2022-11-15 06:35:08 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/shortcodes/index.html" rel = "canonical" type = "text/html" title = "Shortcodes :: Hugo Relearn Theme" >
2022-11-06 00:38:34 +00:00
< link href = "../shortcodes/index.xml" rel = "alternate" type = "application/rss+xml" title = "Shortcodes :: Hugo Relearn Theme" >
2023-02-26 11:53:15 +00:00
< link href = "../images/logo.svg?1677412385" rel = "icon" type = "image/svg+xml" >
2022-07-15 13:20:02 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2023-02-26 11:53:15 +00:00
< link href = "../css/fontawesome-all.min.css?1677412386" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../css/fontawesome-all.min.css?1677412386" rel = "stylesheet" > < / noscript >
< link href = "../css/nucleus.css?1677412386" rel = "stylesheet" >
< link href = "../css/auto-complete.css?1677412386" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../css/auto-complete.css?1677412386" rel = "stylesheet" > < / noscript >
< link href = "../css/perfect-scrollbar.min.css?1677412386" rel = "stylesheet" >
< link href = "../css/fonts.css?1677412386" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../css/fonts.css?1677412386" rel = "stylesheet" > < / noscript >
< link href = "../css/theme.css?1677412386" rel = "stylesheet" >
< link href = "../css/theme-auto.css?1677412386" rel = "stylesheet" id = "variant-style" >
< link href = "../css/variant.css?1677412386" rel = "stylesheet" >
< link href = "../css/print.css?1677412386" rel = "stylesheet" media = "print" >
< link href = "../css/format-print.css?1677412386" rel = "stylesheet" >
< link href = "../css/ie.css?1677412386" rel = "stylesheet" >
< script src = "../js/url.js?1677412386" > < / script >
< script src = "../js/variant.js?1677412386" > < / script >
2022-04-02 13:30:16 +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
2022-11-05 23:35:48 +00:00
window.index_js_url="../index.search.js";
var root_url="../";
2022-04-02 13:30:16 +00:00
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!';
2022-11-17 21:13:11 +00:00
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
2022-04-02 13:30:16 +00:00
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
2023-02-25 21:51:39 +00:00
window.variants & & variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:05:54 +00:00
< style >
#body img.bg-white {
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2022-11-15 06:35:08 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../shortcodes/index.html" >
2022-04-02 13:30:16 +00:00
< div id = "body" class = "default-animation" >
< div id = "sidebar-overlay" > < / div >
< div id = "toc-overlay" > < / div >
2023-02-08 23:54:12 +00:00
< nav id = "topbar" class = "highlightable" >
2022-04-02 13:30:16 +00:00
< div >
< div id = "breadcrumbs" >
< span id = "sidebar-toggle-span" >
2023-02-04 15:02:34 +00:00
< a href = "#" id = "sidebar-toggle" class = "topbar-link" title = 'Menu (CTRL+ALT+n)' > < i class = "fas fa-bars fa-fw" > < / i > < / a >
2022-04-02 13:30:16 +00:00
< / span >
< ol class = "links" itemscope itemtype = "http://schema.org/BreadcrumbList" >
2022-11-05 23:35:48 +00:00
< 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 >
2022-10-02 22:25:49 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < span itemprop = "name" > Shortcodes< / span > < meta itemprop = "position" content = "2" > < / li >
2022-04-02 13:30:16 +00:00
< / ol >
< / div >
< / div >
< / nav >
2022-07-05 22:16:52 +00:00
< main id = "body-inner" class = "highlightable chapter narrow" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
< div id = "head-tags" >
< / div >
2022-11-07 19:58:08 +00:00
< article class = "chapter" >
2022-07-05 22:16:52 +00:00
< div class = "article-subheading" > Chapter 3< / div >
2022-11-13 21:34:47 +00:00
< h1 id = "shortcodes" > Shortcodes< / h1 >
2022-04-02 13:30:16 +00:00
< p > Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’ < / p >
< p > But this happens to be a bad idea. Everyone uses Markdown because it’ s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.< / p >
2022-12-23 11:24:54 +00:00
< p > To avoid this limitations, Hugo created < a href = "https://gohugo.io/extras/shortcodes/" target = "_blank" > shortcodes< / a > . A shortcode is a simple snippet inside a page.< / p >
2022-04-02 13:30:16 +00:00
< p > The Relearn theme provides multiple shortcodes on top of existing ones.< / p >
< div class = "children children-h2 children-sort-" >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/attachments/index.html" > Attachments< / a > < / h2 > < p > List of files attached to a page< / p >
2022-12-01 00:38:08 +00:00
< h2 > < a href = "../shortcodes/badge/index.html" > Badge< / a > < / h2 > < p > Marker badges to display in your text< / p >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/button/index.html" > Button< / a > < / h2 > < p > Clickable buttons< / p >
< h2 > < a href = "../shortcodes/children/index.html" > Children< / a > < / h2 > < p > List the child pages of a page< / p >
< h2 > < a href = "../shortcodes/expand/index.html" > Expand< / a > < / h2 > < p > Expandable/collapsible sections of text< / p >
2022-12-02 17:32:53 +00:00
< h2 > < a href = "../shortcodes/icon/index.html" > Icon< / a > < / h2 > < p > Nice icons for your page< / p >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/include/index.html" > Include< / a > < / h2 > < p > Displays content from other files< / p >
< h2 > < a href = "../shortcodes/math/index.html" > Math< / a > < / h2 > < p > Beautiful math and chemical formulae< / p >
< h2 > < a href = "../shortcodes/mermaid/index.html" > Mermaid< / a > < / h2 > < p > Generate diagrams and flowcharts from text< / p >
< h2 > < a href = "../shortcodes/notice/index.html" > Notice< / a > < / h2 > < p > Disclaimers to help you structure your page< / p >
< h2 > < a href = "../shortcodes/siteparam/index.html" > Site param< / a > < / h2 > < p > Get value of site params< / p >
< h2 > < a href = "../shortcodes/swagger/index.html" > Swagger< / a > < / h2 > < p > UI for your Swagger / OpenAPI Specifications< / p >
2023-01-14 00:40:32 +00:00
< h2 > < a href = "../shortcodes/tabs/index.html" > Tabs< / a > < / h2 > < p > Show content in tabbed views< / p >
2022-04-02 13:30:16 +00:00
< / div >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsections of Shortcodes< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "attachments" > Attachments< / h1 >
2022-07-05 22:16:52 +00:00
2022-05-25 21:31:08 +00:00
< p > The < code > attachments< / code > shortcode displays a list of files attached to a page with adjustable color, title and icon.< / p >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle transparent" >
< div class = "box-label" > < i class = "fa-fw fas fa-paperclip" > < / i > Attachments< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2023-02-19 23:21:31 +00:00
< li > < a href = "../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/BachGavotteShort.mp3" > BachGavotteShort.mp3< / a > (357 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.txt" > hugo.txt< / a > (20 B)< / li >
< li > < a href = "../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.< / p >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > attachments< / span > < span class = "nx" > sort< / span > < span class = "p" > =< / span > < span class = "s" > " asc" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/attachments.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" > " sort" < / span > < span class = "s" > " asc" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2023-01-23 22:49:15 +00:00
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / 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 > style< / strong > < / td >
< td style = "text-align:left" > < code > transparent< / code > < / td >
2023-01-23 23:14:54 +00:00
< td style = "text-align:left" > The style scheme used for the box.< br > < br > - by severity: < code > info< / code > , < code > note< / code > , < code > tip< / code > , < code > warning< / code > < br > - by brand color: < code > primary< / code > , < code > secondary< / code > , < code > accent< / code > < br > - by color: < code > blue< / code > , < code > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > < / td >
2023-01-23 22:49:15 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > color< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > The < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > to be used. If not set, the chosen color depends on the < strong > style< / strong > . Any given value will overwrite the default.< br > < br > - for severity styles: a nice matching color for the severity< br > - for all other styles: the corresponding color< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > title< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > Arbitrary text for the box title. Depending on the < strong > style< / strong > there may be a default title. Any given value will overwrite the default.< br > < br > - for severity styles: the matching title for the severity< br > - for all other styles: < code > Attachments< / code > < br > < br > If you want no title for a severity style, you have to set this parameter to < code > " " < / code > (a non empty string filled with spaces)< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > icon< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > < a href = "../shortcodes/icon/#finding-an-icon" > Font Awesome icon name< / a > set to the left of the title. Depending on the < strong > style< / strong > there may be a default icon. Any given value will overwrite the default.< br > < br > - for severity styles: a nice matching icon for the severity< br > - for all other styles: < code > paperclip< / code > < br > < br > If you want no icon, you have to set this parameter to < code > " " < / code > (a non empty d with spaces)< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > sort< / strong > < / td >
< td style = "text-align:left" > < code > asc< / code > < / td >
< td style = "text-align:left" > Sorting the output in < code > asc< / code > ending or < code > desc< / code > ending order.< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > pattern< / strong > < / td >
< td style = "text-align:left" > < code > .*< / code > < / td >
< td style = "text-align:left" > A < a href = "https://en.wikipedia.org/wiki/Regular_expression" target = "_blank" > regular expressions< / a > , used to filter the attachments by file name. For example:< br > < br > - to match a file suffix of ‘ jpg’ , use < code > .*\.jpg< / code > (not < code > *.\.jpg< / code > )< br > - to match file names ending in < code > jpg< / code > or < code > png< / code > , use < code > .*\.(jpg|png)< / code > < / td >
< / tr >
< / tbody >
< / table >
< h2 id = "setup" > Setup< / h2 >
< h3 id = "single-language" > Single language< / h3 >
2022-12-23 02:25:15 +00:00
< p > The shortcode lists files found in a specific folder. The name of the folder depends on your page type (either branch bundle, leaf bundle or page).< / p >
2022-04-02 13:30:16 +00:00
< ol >
< li >
2022-12-23 02:25:15 +00:00
< p > For simple pages, attachments must be placed in a folder named like your page and ending with < code > .files< / code > .< / p >
2022-04-02 13:30:16 +00:00
< blockquote >
< ul >
< li > content
< ul >
< li > _index.md< / li >
2022-06-05 17:32:37 +00:00
< li > < strong > page.files< / strong >
2022-04-02 13:30:16 +00:00
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< li > page.md< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
< / li >
< li >
2023-01-14 00:40:32 +00:00
< p > If your page is a branch or leaf bundle, attachments must be placed in a nested < code > _index.files< / code > or < code > index.files< / code > folder, accordingly.< / p >
2022-12-23 02:25:15 +00:00
< p > For branch bundles:< / p >
2022-04-02 13:30:16 +00:00
< blockquote >
< ul >
< li > content
< ul >
< li > _index.md< / li >
< li > page
< ul >
< li > index.md< / li >
2022-12-23 02:25:15 +00:00
< li > < strong > index.files< / strong >
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
< p > For leaf bundles:< / p >
< blockquote >
< ul >
< li > content
< ul >
< li > _index.md< / li >
< li > page
< ul >
< li > _index.md< / li >
< li > < strong > _index.files< / strong >
2022-04-02 13:30:16 +00:00
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
< / li >
< / ol >
2023-01-23 22:49:15 +00:00
< h3 id = "multilingual" > Multilingual< / h3 >
2022-12-23 02:25:15 +00:00
< p > Be aware that if you use a multilingual website, you will need to have as many folders as languages and the language code must be part of the folder name.< / p >
< p > Eg. for a site in English and Piratish:< / p >
< blockquote >
< ul >
< li > content
< ul >
< li > _index.en.md< / li >
< li > _index.pir.md< / li >
< li > < strong > page.en.files< / strong >
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< li > < strong > page.pir.files< / strong >
< ul >
< li > attachment.pdf< / li >
< / ul >
< / li >
< li > page.en.md< / li >
< li > page.pir.md< / li >
< / ul >
< / li >
< / ul >
< / blockquote >
2022-05-25 21:31:08 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-06-05 17:32:37 +00:00
< h3 id = "custom-title-list-of-attachments-ending-in-pdf-or-mp4" > Custom Title, List of Attachments Ending in pdf or mp4< / h3 >
2023-01-14 00:40:32 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > attachments< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Related files" < / span > < span class = "nx" > pattern< / span > < span class = "p" > =< / span > < span class = "s" > " .*\.(pdf|mp4)" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle transparent" >
< div class = "box-label" > < i class = "fa-fw fas fa-paperclip" > < / i > Related files< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2023-02-19 23:21:31 +00:00
< li > < a href = "../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "info-styled-box-descending-sort-order" > Info Styled Box, Descending Sort Order< / h3 >
< 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" > attachments< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > sort< / span > < span class = "p" > =< / span > < span class = "s" > " desc" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
2022-05-25 21:31:08 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box attachments cstyle info" >
< div class = "box-label" > < i class = "fa-fw fas fa-info-circle" > < / i > Info< / div >
2022-04-02 13:30:16 +00:00
< ul class = "box-content attachments-files" >
2023-02-19 23:21:31 +00:00
< li > < a href = "../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.txt" > hugo.txt< / a > (20 B)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/BachGavotteShort.mp3" > BachGavotteShort.mp3< / a > (357 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
2022-04-02 13:30:16 +00:00
< / ul >
< / div >
2023-01-23 22:49:15 +00:00
< h3 id = "with-user-defined-color-and-font-awesome-brand-icon" > With User-Defined Color and Font Awesome Brand Icon< / h3 >
< 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" > attachments< / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > /%< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box attachments cstyle default" style = "--VARIABLE-BOX-color: fuchsia;" >
< div class = "box-label" > < i class = "fab fa-hackerrank" > < / i > Attachments< / div >
< ul class = "box-content attachments-files" >
2023-02-19 23:21:31 +00:00
< li > < a href = "../shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf" > adivorciarsetoca00cape.pdf< / a > (361 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/BachGavotteShort.mp3" > BachGavotteShort.mp3< / a > (357 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf" > Carroll_AliceAuPaysDesMerveilles.pdf< / a > (175 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.png" > hugo.png< / a > (17 KB)< / li >
< li > < a href = "../shortcodes/attachments.en.files/hugo.txt" > hugo.txt< / a > (20 B)< / li >
< li > < a href = "../shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4" > movieselectricsheep-flock-244-32500-2.mp4< / a > (340 KB)< / li >
2023-01-23 22:49:15 +00:00
< / ul >
< / div >
< h3 id = "style-color-title-and-icons" > Style, Color, Title and Icons< / h3 >
< p > For further examples for < strong > style< / strong > , < strong > color< / strong > , < strong > title< / strong > and < strong > icon< / strong > , see the < a href = "../shortcodes/notice/" > < code > notice< / code > shortcode< / a > documentation. The parameter are working the same way for both shortcodes, besides having different defaults.< / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-12-01 00:38:08 +00:00
< article class = "default" >
< h1 id = "badge" > Badge< / h1 >
< p > The < code > badge< / code > shortcode displays little markers in your text with adjustable color, title and icon.< / p >
< p > < span class = "badge cstyle default" > < span class = "badge-content" > Important< / span > < / span >
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > Version< / span > < span class = "badge-content" > 6.6.6< / span > < / span >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > < / span > < span class = "badge-content" > Captain< / span > < / span >
2023-01-23 22:49:15 +00:00
< span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-info-circle" > < / i > Info< / span > < span class = "badge-content" > New< / span > < / span >
< span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > Awesome< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h2 id = "usage" > Usage< / h2 >
< p > While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.< / p >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-12-01 00:38:08 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-12-01 00:38:08 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-12-01 00:38:08 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-12-01 00:38:08 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-12-01 00:38:08 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-12-01 00:38:08 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Important< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Version" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / 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 class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2023-01-23 22:49:15 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > New< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-12-01 00:38:08 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/badge.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" > " content" < / span > < span class = "s" > " Important" < / 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/badge.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" > " style" < / span > < span class = "s" > " primary" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " title" < / span > < span class = "s" > " Version" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " 6.6.6" < / 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/badge.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" > " style" < / span > < span class = "s" > " red" < / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " angle-double-up" < / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Captain" < / 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/badge.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" > " style" < / span > < span class = "s" > " info" < / span >
2023-01-23 22:49:15 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " New" < / 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/badge.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" > " color" < / span > < span class = "s" > " fuchsia" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " fab fa-hackerrank" < / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Awesome" < / 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" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > style< / strong > < / td >
2022-12-01 08:14:48 +00:00
< td style = "text-align:left" > < code > default< / code > < / td >
2023-01-23 23:14:54 +00:00
< td style = "text-align:left" > The style scheme used for the badge.< br > < br > - by severity: < code > info< / code > , < code > note< / code > , < code > tip< / code > , < code > warning< / code > < br > - by brand color: < code > primary< / code > , < code > secondary< / code > , < code > accent< / code > < br > - by color: < code > blue< / code > , < code > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > < / td >
2022-12-01 00:38:08 +00:00
< / tr >
< tr >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > < strong > color< / strong > < / td >
2022-12-01 00:38:08 +00:00
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > The < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > to be used. If not set, the chosen color depends on the < strong > style< / strong > . Any given value will overwrite the default.< br > < br > - for severity styles: a nice matching color for the severity< br > - for all other styles: the corresponding color< / td >
2022-12-01 00:38:08 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > title< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > Arbitrary text for the badge title. Depending on the < strong > style< / strong > there may be a default title. Any given value will overwrite the default.< br > < br > - for severity styles: the matching title for the severity< br > - for all other styles: < em > < empty> < / em > < br > < br > If you want no title for a severity style, you have to set this parameter to < code > " " < / code > (a non empty string filled with spaces)< / td >
< / tr >
< tr >
< td style = "text-align:left" > < strong > icon< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > < a href = "../shortcodes/icon/#finding-an-icon" > Font Awesome icon name< / a > set to the left of the title. Depending on the < strong > style< / strong > there may be a default icon. Any given value will overwrite the default.< br > < br > - for severity styles: a nice matching icon for the severity< br > - for all other styles: < em > < empty> < / em > < br > < br > If you want no icon for a severity style, you have to set this parameter to < code > " " < / code > (a non empty string filled with spaces)< / td >
2022-12-01 00:38:08 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
2022-12-01 08:14:48 +00:00
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > Arbitrary text for the badge.< / td >
2022-12-01 00:38:08 +00:00
< / tr >
< / tbody >
< / table >
< h2 id = "examples" > Examples< / h2 >
< h3 id = "style" > Style< / h3 >
< h4 id = "by-severity" > By Severity< / h4 >
< 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > New< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " note" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Change< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " tip" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Optional< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Breaking< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-info-circle" > < / i > Info< / span > < span class = "badge-content" > New< / span > < / span >
< span class = "badge cstyle note badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / span > < span class = "badge-content" > Change< / span > < / span >
< span class = "badge cstyle tip badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-lightbulb" > < / i > Tip< / span > < span class = "badge-content" > Optional< / span > < / span >
< span class = "badge cstyle warning badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > Warning< / span > < span class = "badge-content" > Breaking< / span > < / span > < / p >
< h4 id = "by-brand-colors" > By Brand Colors< / h4 >
< 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " bullhorn" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Announcement" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Mandatory< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " secondary" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " bullhorn" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Announcement" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Optional< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2023-01-23 23:14:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " accent" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " bullhorn" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Announcement" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Special< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-bullhorn" > < / i > Announcement< / span > < span class = "badge-content" > Mandatory< / span > < / span >
2023-01-23 23:14:54 +00:00
< span class = "badge cstyle secondary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-bullhorn" > < / i > Announcement< / span > < span class = "badge-content" > Optional< / span > < / span >
< span class = "badge cstyle accent badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-bullhorn" > < / i > Announcement< / span > < span class = "badge-content" > Special< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h4 id = "by-color" > By Color< / h4 >
< 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Blue< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " green" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Green< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " grey" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Grey< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " orange" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Orange< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Red< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle blue badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Blue< / span > < / span >
< span class = "badge cstyle green badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Green< / span > < / span >
< span class = "badge cstyle grey badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Grey< / span > < / span >
< span class = "badge cstyle orange badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Orange< / span > < / span >
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Red< / span > < / span > < / p >
< h4 id = "by-special-color" > By Special Color< / h4 >
< 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " default" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Default< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " transparent" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " palette" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Color" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Transparent< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Default< / span > < / span >
< span class = "badge cstyle transparent badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-palette" > < / i > Color< / span > < span class = "badge-content" > Transparent< / span > < / span > < / p >
< h3 id = "variants" > Variants< / h3 >
< h4 id = "without-icon-and-title-text" > Without Icon and Title Text< / h4 >
< 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" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default" > < span class = "badge-content" > 6.6.6< / span > < / span >
< span class = "badge cstyle info" > < span class = "badge-content" > Awesome< / span > < / span >
< span class = "badge cstyle red" > < span class = "badge-content" > Captain< / span > < / span > < / p >
< h4 id = "without-icon" > Without Icon< / h4 >
< 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" > badge< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Version" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > Version< / span > < span class = "badge-content" > 6.6.6< / span > < / span >
< span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > Info< / span > < span class = "badge-content" > Awesome< / span > < / span >
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > Rank< / span > < span class = "badge-content" > Captain< / span > < / span > < / p >
< h4 id = "without-title-text" > Without Title Text< / h4 >
< 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" > badge< / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " star" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / 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 class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-star" > < / i > < / span > < span class = "badge-content" > 6.6.6< / span > < / span >
< span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-info-circle" > < / i > < / span > < span class = "badge-content" > Awesome< / span > < / span >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > < / span > < span class = "badge-content" > Captain< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h4 id = "all-set" > All Set< / h4 >
< 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" > badge< / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " star" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Version" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "mf" > 6.6.6< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Captain< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-01 00:38:08 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-star" > < / i > Version< / span > < span class = "badge-content" > 6.6.6< / span > < / span >
< span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-info-circle" > < / i > Info< / span > < span class = "badge-content" > Awesome< / span > < / span >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle red badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > Rank< / span > < span class = "badge-content" > Captain< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h4 id = "override-for-severity" > Override for Severity< / h4 >
< 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" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " rocket" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Feature" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < span class = "badge cstyle info badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-rocket" > < / i > Feature< / span > < span class = "badge-content" > Awesome< / span > < / span >
< h3 id = "other" > Other< / h3 >
2023-01-23 22:49:15 +00:00
< h4 id = "with-user-defined-color-and-font-awesome-brand-icon" > With User-Defined Color and Font Awesome Brand Icon< / h4 >
< 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" > badge< / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < span class = "badge cstyle default badge-with-title" > < span class = "badge-title" > < i class = "fab fa-hackerrank" > < / i > < / span > < span class = "badge-content" style = "background-color: fuchsia;" > Awesome< / span > < / span >
2022-12-02 17:32:53 +00:00
< h4 id = "with-icon-content" > With Icon Content< / h4 >
2023-01-23 22:49:15 +00:00
< p > You can combine the badge with the < a href = "../shortcodes/icon/" > < code > icon< / code > shortcode< / a > to create even more stunning visuals.< / p >
2022-12-02 17:32:53 +00:00
< p > In this case you need to declare < code > {{< badge > }}< / code > instead of < code > {{% badge %}}< / code > . Note, that in this case it is not possible to put markdown in the content.< / p >
2022-12-02 18:27:40 +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 = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < 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 class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < 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 class = "nx" > Pirate< / span > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < 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 class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < 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 class = "nx" > Pirate< / span > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < 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 class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " angle-double-up" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Rank" < / span > < 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 class = "nx" > Pirate< / span > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "p" > > }}< / span >
2022-12-02 17:32:53 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > < / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > < / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > < / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > Pirate< / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > Rank< / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > < / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > Rank< / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > Pirate< / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > Rank< / span > < span class = "badge-content" >
2022-12-02 18:27:40 +00:00
< i class = "fa-fw fas fa-skull-crossbones" > < / i > < / span > < / span > < br >
2022-12-02 17:32:53 +00:00
< span class = "badge cstyle primary badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-angle-double-up" > < / i > Rank< / span > < span class = "badge-content" >
< i class = "fa-fw fas fa-skull-crossbones" > < / i > Pirate< / span > < / span > < / p >
2022-12-01 00:38:08 +00:00
< h4 id = "inside-of-text" > Inside of Text< / h4 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "nx" > Lorem< / span > < span class = "nx" > ipsum< / span > < span class = "nx" > dolor< / span > < span class = "nx" > sit< / span > < span class = "nx" > amet< / span > < span class = "p" > ,< / span > < span class = "nx" > graecis< / span > < span class = "nx" > denique< / span > < span class = "nx" > ei< / span > < span class = "nx" > vel< / span > < span class = "p" > ,< / span > < span class = "nx" > at< / span > < span class = "nx" > duo< / span > < span class = "nx" > primis< / span > < span class = "nx" > mandamus< / span > < span class = "p" > .< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > badge< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " rocket" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Awesome< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > badge< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Et< / span > < span class = "nx" > legere< / span > < span class = "nx" > ocurreret< / span > < span class = "nx" > pri< / span > < span class = "p" > ,< / span > < span class = "nx" > animal< / span > < span class = "nx" > tacimates< / span > < span class = "nx" > complectitur< / span > < span class = "nx" > ad< / span > < span class = "nx" > cum< / span > < span class = "p" > .< / span > < span class = "nx" > Cu< / span > < span class = "nx" > eum< / span > < span class = "nx" > inermis< / span > < span class = "nx" > inimicus< / span > < span class = "nx" > efficiendi< / span > < span class = "p" > .< / span > < span class = "nx" > Labore< / span > < span class = "nx" > officiis< / span > < span class = "nx" > his< / span > < span class = "nx" > ex< / span > < span class = "p" > ,< / span > < span class = "nx" > soluta< / span > < span class = "nx" > officiis< / span > < span class = "nx" > concludaturque< / span > < span class = "nx" > ei< / span > < span class = "nx" > qui< / span > < span class = "p" > ,< / span > < span class = "nx" > vide< / span > < span class = "nx" > sensibus< / span > < span class = "nx" > vim< / span > < span class = "nx" > ad< / span > < span class = "p" > .< / span >
< / span > < / span > < / code > < / pre > < / div > < p > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. < span class = "badge cstyle blue badge-with-title" > < span class = "badge-title" > < i class = "fa-fw fas fa-rocket" > < / i > < / span > < span class = "badge-content" > Awesome< / span > < / span > 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 >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "button" > Button< / h1 >
2022-07-05 22:16:52 +00:00
2022-05-29 21:00:53 +00:00
< p > The < code > button< / code > shortcode displays a clickable button with adjustable color, title and icon.< / p >
< p >
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
< / span >
< span class = "btn cstyle warning" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-dragon" > < / i >
Get Hugo
< / a >
< / span > < / p >
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.< / p >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " dragon" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/button.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" > " href" < / span > < span class = "s" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Get Hugo" < / 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/button.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" > " href" < / span > < span class = "s" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " style" < / span > < span class = "s" > " warning" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " icon" < / span > < span class = "s" > " dragon" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Get Hugo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< p > Once the button is clicked, it opens another browser tab for the given URL.< / p >
2022-06-05 17:32:37 +00:00
< h3 id = "parameter" > Parameter< / h3 >
2022-05-29 21:00:53 +00:00
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / 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 > href< / strong > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-11-28 17:44:03 +00:00
< td style = "text-align:left" > Either the destination URL for the button or JavaScript code to be executed on click. If this parameter is not set, the button will do nothing but is still displayed as clickable.< br > < br > - if starting with < code > javascript:< / code > all following text will be executed in your browser< br > - every other string will be interpreted as URL< / td >
2022-05-29 21:00:53 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > style< / strong > < / td >
< td style = "text-align:left" > < code > transparent< / code > < / td >
2023-01-23 23:14:54 +00:00
< td style = "text-align:left" > The style scheme used for the button.< br > < br > - by severity: < code > info< / code > , < code > note< / code > , < code > tip< / code > , < code > warning< / code > < br > - by brand color: < code > primary< / code > , < code > secondary< / code > , < code > accent< / code > < br > - by color: < code > blue< / code > , < code > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > < / td >
2023-01-23 22:49:15 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > color< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > The < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > to be used. If not set, the chosen color depends on the < strong > style< / strong > . Any given value will overwrite the default.< br > < br > - for severity styles: a nice matching color for the severity< br > - for all other styles: the corresponding color< / td >
2022-05-29 21:00:53 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > icon< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > < a href = "../shortcodes/icon/#finding-an-icon" > Font Awesome icon name< / a > set to the left of the title. Depending on the < strong > style< / strong > there may be a default icon. Any given value will overwrite the default.< br > < br > - for severity styles: a nice matching icon for the severity< br > - for all other styles: < em > < empty> < / em > < br > < br > If you want no icon for a severity style, you have to set this parameter to < code > " " < / code > (a non empty string filled with spaces)< / td >
2022-05-29 21:00:53 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > iconposition< / strong > < / td >
< td style = "text-align:left" > < code > left< / code > < / td >
< td style = "text-align:left" > Places the icon to the < code > left< / code > or < code > right< / code > of the title.< / td >
< / tr >
< tr >
2022-10-31 20:10:53 +00:00
< td style = "text-align:left" > < strong > target< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2022-12-26 01:09:01 +00:00
< td style = "text-align:left" > The destination frame/window if < strong > href< / strong > is an URL. Otherwise the parameter is not used. This behaves similar to normal links. If the parameter is not given it defaults to:< br > < br > - the setting of < code > externalLinkTarget< / code > or < code > _blank< / code > if not set, for any address starting with < code > http://< / code > or < code > https://< / code > < br > - no specific value for all other links< / td >
2022-11-28 17:44:03 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > type< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2022-12-23 11:24:54 +00:00
< td style = "text-align:left" > The < a href = "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type" target = "_blank" > button type< / a > if < strong > href< / strong > is JavaScript. Otherwise the parameter is not used. If the parameter is not given it defaults to < code > button< / code > < / td >
2022-10-31 20:10:53 +00:00
< / tr >
< tr >
2022-05-29 21:00:53 +00:00
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > Arbitrary text for the button title. Depending on the < strong > style< / strong > there may be a default title. Any given value will overwrite the default.< br > < br > - for severity styles: the matching title for the severity< br > - for all other styles: < em > < empty> < / em > < br > < br > If you want no title for a severity style, you have to set this parameter to < code > " " < / code > (a non empty string filled with spaces)< / td >
2022-05-29 21:00:53 +00:00
< / tr >
< / tbody >
< / table >
< h2 id = "examples" > Examples< / h2 >
< h3 id = "style" > Style< / h3 >
2022-06-05 17:32:37 +00:00
< h4 id = "by-severity" > By Severity< / h4 >
< 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " note" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " tip" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle info" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-info-circle" > < / i >
Get Hugo
< / a >
< / span >
< span class = "btn cstyle note" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-exclamation-circle" > < / i >
Get Hugo
< / a >
< / span >
< span class = "btn cstyle tip" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-lightbulb" > < / i >
Get Hugo
< / a >
< / span >
< span class = "btn cstyle warning" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-exclamation-triangle" > < / i >
Get Hugo
< / a >
< / span > < / p >
2022-06-05 17:32:37 +00:00
< h4 id = "by-brand-colors" > By Brand Colors< / h4 >
< 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " secondary" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2023-01-23 23:14:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " accent" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div > < p >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle primary" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
< / span >
< span class = "btn cstyle secondary" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
2023-01-23 23:14:54 +00:00
< / span >
< span class = "btn cstyle accent" >
< a href = "https://gohugo.io/" target = "_blank" >
Get Hugo
< / a >
2022-05-29 21:00:53 +00:00
< / span > < / p >
2022-06-05 17:32:37 +00:00
< h4 id = "by-color" > By Color< / h4 >
< 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " green" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " grey" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " orange" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle blue" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
< / span >
< span class = "btn cstyle green" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
< / span >
< span class = "btn cstyle grey" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
< / span >
< span class = "btn cstyle orange" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
< / span >
< span class = "btn cstyle red" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
< / span > < / p >
2022-06-05 17:32:37 +00:00
< h4 id = "by-special-color" > By Special Color< / h4 >
< 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " default" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " transparent" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle default" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
< / span >
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
Get Hugo
< / a >
< / span > < / p >
< h3 id = "icon" > Icon< / h3 >
2022-06-05 17:32:37 +00:00
< h4 id = "to-the-left" > To the Left< / h4 >
< 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " download" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-download" > < / i >
Get Hugo
< / a >
< / span >
2022-06-05 17:32:37 +00:00
< h4 id = "to-the-right" > To the Right< / h4 >
2022-06-23 11:25:28 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " download" < / span > < span class = "nx" > iconposition< / span > < span class = "p" > =< / span > < span class = "s" > " right" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-06-22 22:08:50 +00:00
Get Hugo
2022-06-23 11:25:28 +00:00
< i class = "fa-fw fas fa-download" > < / i >
2022-05-29 21:00:53 +00:00
< / a >
< / span >
< h4 id = "override-for-severity" > Override for Severity< / h4 >
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " dragon" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle warning" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-dragon" > < / i >
Get Hugo
< / a >
< / span >
2022-10-31 20:10:53 +00:00
< h3 id = "target" > Target< / h3 >
< 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > target< / span > < span class = "p" > =< / span > < span class = "s" > " _self" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "nx" > in< / span > < span class = "nx" > same< / span > < span class = "nx" > window< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Get< / span > < span class = "nx" > Hugo< / span > < span class = "nx" > in< / span > < span class = "nx" > new< / span > < span class = "nx" > Window< / span > < span class = "o" > /< / span > < span class = "nf" > Frame< / span > < span class = "p" > (< / span > < span class = "k" > default< / span > < span class = "p" > ){{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div > < p >
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_self" >
2022-10-31 20:10:53 +00:00
Get Hugo in same Window/Frame
< / a >
< / span >
< span class = "btn cstyle transparent" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-10-31 20:10:53 +00:00
Get Hugo in new Window/Frame (default)
< / a >
< / span > < / p >
2022-05-29 21:00:53 +00:00
< h3 id = "other" > Other< / h3 >
2023-01-23 22:49:15 +00:00
< h4 id = "with-user-defined-color-and-font-awesome-brand-icon" > With User-Defined Color and Font Awesome Brand Icon< / h4 >
< 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" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Hugo< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< span class = "btn cstyle default" style = "--VARIABLE-BOX-color: fuchsia;" >
< a href = "https://gohugo.io/" target = "_blank" >
< i class = "fab fa-hackerrank" > < / i >
Hugo
< / a >
< / span >
2022-11-28 17:44:03 +00:00
< h4 id = "severity-style-with-all-defaults" > Severity Style with All Defaults< / h4 >
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " https://gohugo.io/" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " tip" < / span > < span class = "o" > %< / span > < span class = "p" > }}{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< span class = "btn cstyle tip" >
2022-12-23 11:24:54 +00:00
< a href = "https://gohugo.io/" target = "_blank" >
2022-05-29 21:00:53 +00:00
< i class = "fa-fw fas fa-lightbulb" > < / i >
Tip
< / a >
< / span >
2022-11-28 17:44:03 +00:00
< h4 id = "button-to-internal-page" > Button to Internal Page< / h4 >
2023-01-23 12:45:44 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > button< / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " /index.html" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Home< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-10-31 20:10:53 +00:00
< / span > < / span > < / code > < / pre > < / div >
< span class = "btn cstyle transparent" >
2023-01-23 12:45:44 +00:00
< a href = "../index.html" >
2022-10-31 20:10:53 +00:00
Home
< / a >
< / span >
2022-11-28 17:44:03 +00:00
< h4 id = "button-with-javascript-action" > Button with JavaScript Action< / h4 >
< p > If your JavaScript action does not change the focus afterwards, make sure to call < code > this.blur()< / code > in the end to unselect the button.< / p >
< 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" > button< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " bullhorn" < / span > < span class = "nx" > href< / span > < span class = "p" > =< / span > < span class = "s" > " javascript:alert(' Hello world!' );this.blur();" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Shout< / span > < span class = "nx" > it< / span > < span class = "nx" > out< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > button< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< span class = "btn cstyle primary" >
< button onclick = "alert('Hello world!');this.blur();" type = "button" >
< i class = "fa-fw fas fa-bullhorn" > < / i >
Shout it out
< / button >
< / span >
< h4 id = "button-within-a-form-element" > Button within a < code > form< / code > Element< / h4 >
< p > To use native HTML elements in your Markdown, add this in your < code > config.toml< / code > < / p >
< div class = "highlight" > < 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 > < div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-html" data-lang = "html" > < span class = "line" > < span class = "cl" > < span class = "p" > < < / span > < span class = "nt" > form< / span > < span class = "na" > action< / span > < span class = "o" > =< / span > < span class = "s" > " ../../search.html" < / span > < span class = "na" > method< / span > < span class = "o" > =< / span > < span class = "s" > " get" < / span > < span class = "p" > > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > < < / span > < span class = "nt" > input< / span > < span class = "na" > name< / span > < span class = "o" > =< / span > < span class = "s" > " search-by-detail" < / span > < span class = "na" > class< / span > < span class = "o" > =< / span > < span class = "s" > " search-by" < / span > < span class = "na" > type< / span > < span class = "o" > =< / span > < span class = "s" > " search" < / span > < span class = "p" > > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > {{% button type=" submit" style=" secondary" icon=" search" %}}Search{{% /button %}}
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > < /< / span > < span class = "nt" > form< / span > < span class = "p" > > < / span >
< / span > < / span > < / code > < / pre > < / div > < form action = "../../search.html" method = "get" >
< div class = "searchform" style = "width: 20vw;" >
< input name = "search-by-detail" class = "search-by" type = "search" placeholder = "Search..." >
< span class = "btn cstyle secondary" >
< button type = "submit" >
< i class = "fa-fw fas fa-search" > < / i >
Search
< / button >
< / span >
< / div >
< / form >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "children" > Children< / h1 >
2022-07-05 22:16:52 +00:00
2023-01-14 00:40:32 +00:00
< p > The < code > children< / code > shortcode lists the child pages of the current page and its descendants.< / p >
2022-06-22 22:08:50 +00:00
< ul class = "children children-li children-sort-weight" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/test/index.html" > page X< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/index.html" > page 1< / a > < / li >
< li > < a href = "../shortcodes/children/children-2/index.html" > page 2< / a > < / li >
< li > < a href = "../shortcodes/children/children-3/index.html" > page 3< / a > < / li >
2022-06-22 22:08:50 +00:00
< / ul >
2022-04-02 13:30:16 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.< / p >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "nx" > sort< / span > < span class = "p" > =< / span > < span class = "s" > " weight" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/children.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" > " sort" < / span > < span class = "s" > " weight" < / 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 >
2022-04-02 13:30:16 +00:00
< table >
< thead >
< tr >
2022-06-05 17:32:37 +00:00
< th style = "text-align:left" > Name< / th >
2022-04-02 13:30:16 +00:00
< th style = "text-align:left" > Default< / th >
2022-06-05 17:32:37 +00:00
< th style = "text-align:left" > Notes< / th >
2022-04-02 13:30:16 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > containerstyle< / strong > < / td >
< td style = "text-align:left" > < code > ul< / code > < / td >
< td style = "text-align:left" > Choose the style used to group all children. It could be any HTML tag name.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > style< / strong > < / td >
< td style = "text-align:left" > < code > li< / code > < / td >
< td style = "text-align:left" > Choose the style used to display each descendant. It could be any HTML tag name.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > showhidden< / strong > < / td >
< td style = "text-align:left" > < code > false< / code > < / td >
2022-10-31 14:06:51 +00:00
< td style = "text-align:left" > When < code > true< / code > , child pages hidden from the menu will be displayed as well.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > description< / strong > < / td >
< td style = "text-align:left" > < code > false< / code > < / td >
2022-12-23 11:24:54 +00:00
< td style = "text-align:left" > When < code > true< / code > shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - < a href = "https://gohugo.io/content/summaries/" target = "_blank" > read more info about summaries on gohugo.io< / a > .< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > depth< / strong > < / td >
< td style = "text-align:left" > < code > 1< / code > < / td >
< td style = "text-align:left" > The depth of descendants to display. For example, if the value is < code > 2< / code > , the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. < code > 999< / code > .< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < strong > sort< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
2022-12-16 17:42:17 +00:00
< td style = "text-align:left" > The sort order of the displayed list.< br > < br > If not set it is sorted by the < a href = "../basics/configuration/#global-site-parameters" > < code > ordersectionsby< / code > < / a > setting of the site and the pages frontmatter< br > < br > - < code > weight< / code > : to sort on menu order< br > - < code > title< / code > : to sort alphabetically on menu label.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< / tbody >
< / table >
2022-06-05 17:32:37 +00:00
< h2 id = "examples" > Examples< / h2 >
< h3 id = "all-default" > All Default< / h3 >
2022-04-02 13:30:16 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/test/index.html" > page X< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/index.html" > page 1< / a > < / li >
< li > < a href = "../shortcodes/children/children-2/index.html" > page 2< / a > < / li >
< li > < a href = "../shortcodes/children/children-3/index.html" > page 3< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2022-06-05 17:32:37 +00:00
< h3 id = "with-description" > With Description< / h3 >
2022-04-02 13:30:16 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "nx" > description< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/test/index.html" > page X< / a > < p > This is a plain page test, and the beginning of a YAML multiline description...
2022-10-07 18:46:19 +00:00
< / p > < / li >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-1/index.html" > page 1< / a > < p > This is a demo child page< / p > < / li >
< li > < a href = "../shortcodes/children/children-2/index.html" > page 2< / a > < p > This is a demo child page with no description.
2022-10-07 18:46:19 +00:00
So its content is used as description.< / p > < / li >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-3/index.html" > page 3< / a > < p > This is a demo child page< / p > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2022-10-31 14:06:51 +00:00
< h3 id = "infinite-depth-and-hidden-pages" > Infinite Depth and Hidden Pages< / h3 >
2022-04-02 13:30:16 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "nx" > depth< / span > < span class = "p" > =< / span > < span class = "s" > " 999" < / span > < span class = "nx" > showhidden< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/test/index.html" > page X< / a > < ul >
< / ul > < / li >
< li > < a href = "../shortcodes/children/children-1/index.html" > page 1< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/index.html" > page 1-1< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html" > page 1-1-1 (hidden)< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html" > page 1-1-1-1< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html" > page 1-1-1-1-1 (hidden)< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html" > page 1-1-1-1-1-1< / a > < ul >
< / ul > < / li > < / ul > < / li > < / ul > < / li > < / ul > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" > page 1-1-2< / a > < ul >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html" > page 1-1-2-1< / a > < ul >
< / ul > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html" > page 1-1-2-2< / a > < ul >
< / ul > < / li > < / ul > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" > page 1-1-3< / a > < ul >
< / ul > < / li > < / ul > < / li > < / ul > < / li >
< li > < a href = "../shortcodes/children/children-2/index.html" > page 2< / a > < ul >
< / ul > < / li >
< li > < a href = "../shortcodes/children/children-3/index.html" > page 3< / a > < ul >
< li > < a href = "../shortcodes/children/children-3/test3/index.html" > page 3-1< / a > < ul >
< / ul > < / li > < / ul > < / li >
< li > < a href = "../shortcodes/children/children-4/index.html" > page 4 (hidden)< / a > < ul >
< / ul > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
2022-06-05 17:32:37 +00:00
< h3 id = "heading-styles-for-container-and-elements" > Heading Styles for Container and Elements< / h3 >
2022-04-02 13:30:16 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > children< / span > < span class = "nx" > containerstyle< / span > < span class = "p" > =< / span > < span class = "s" > " div" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " h2" < / span > < span class = "nx" > depth< / span > < span class = "p" > =< / span > < span class = "s" > " 3" < / span > < span class = "nx" > description< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "children children-h2 children-sort-" >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/children/test/index.html" > page X< / a > < / h2 > < p > This is a plain page test, and the beginning of a YAML multiline description...
2022-06-23 18:04:40 +00:00
< / p >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/children/children-1/index.html" > page 1< / a > < / h2 > < p > This is a demo child page< / p >
< h3 > < a href = "../shortcodes/children/children-1/children-1-1/index.html" > page 1-1< / a > < / h3 > < p > This is a demo child page< / p >
< h4 > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" > page 1-1-2< / a > < / h4 > < p > This is a demo child page< / p >
< h4 > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" > page 1-1-3< / a > < / h4 > < p > This is a demo child page< / p >
< h2 > < a href = "../shortcodes/children/children-2/index.html" > page 2< / a > < / h2 > < p > This is a demo child page with no description.
2022-06-23 18:04:40 +00:00
So its content is used as description.< / p >
2022-11-08 14:43:28 +00:00
< h2 > < a href = "../shortcodes/children/children-3/index.html" > page 3< / a > < / h2 > < p > This is a demo child page< / p >
< h3 > < a href = "../shortcodes/children/children-3/test3/index.html" > page 3-1< / a > < / h3 > < p > This is a plain page test nested in a parent< / p >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "divs-for-group-and-element-styles" > Divs for Group and Element Styles< / h3 >
< 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" > children< / span > < span class = "nx" > containerstyle< / span > < span class = "p" > =< / span > < span class = "s" > " div" < / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " div" < / span > < span class = "nx" > depth< / span > < span class = "p" > =< / span > < span class = "s" > " 3" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "children children-div children-sort-" >
2022-11-08 14:43:28 +00:00
< div > < a href = "../shortcodes/children/test/index.html" > page X< / a > < / div >
< div > < a href = "../shortcodes/children/children-1/index.html" > page 1< / a > < / div >
< div > < a href = "../shortcodes/children/children-1/children-1-1/index.html" > page 1-1< / a > < / div >
< div > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" > page 1-1-2< / a > < / div >
< div > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" > page 1-1-3< / a > < / div >
< div > < a href = "../shortcodes/children/children-2/index.html" > page 2< / a > < / div >
< div > < a href = "../shortcodes/children/children-3/index.html" > page 3< / a > < / div >
< div > < a href = "../shortcodes/children/children-3/test3/index.html" > page 3-1< / a > < / div >
2022-04-02 13:30:16 +00:00
< / div >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsections of Children< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-x" > page X< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This is a plain demo child page.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-1" > page 1< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This is a demo child page.< / p >
< h2 id = "subpages-of-this-page" > Subpages of this page< / h2 >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-1/children-1-1/index.html" > page 1-1< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsections of page 1< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-1-1" > page 1-1< / h1 >
2022-07-05 22:16:52 +00:00
2022-12-16 17:42:17 +00:00
< p > This is a demo child page with a hidden child. You can still access the hidden child < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/" > directly< / a > or via the search.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "subpages-of-this-page" > Subpages of this page< / h2 >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-1/index.html" > page 1-1-1 (hidden)< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/index.html" > page 1-1-2< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-3/index.html" > page 1-1-3< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsections of page 1-1< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-1-1-2" > page 1-1-2< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This is a plain demo child page.< / p >
< h2 id = "subpages-of-this-page" > Subpages of this page< / h2 >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html" > page 1-1-2-1< / a > < / li >
< li > < a href = "../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html" > page 1-1-2-2< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsections of page 1-1-2< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-1-1-2-1" > page 1-1-2-1< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This is a plain demo child page.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-1-1-2-2" > page 1-1-2-2< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This is a plain demo child page.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< / section >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-1-1-3" > page 1-1-3< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This is a plain demo child page.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< / section >
< / section >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-2" > page 2< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This is a demo child page with no description.< / p >
< p > So its content is used as description.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-3" > page 3< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This is a demo child page.< / p >
< h2 id = "subpages-of-this-page" > Subpages of this page< / h2 >
< ul class = "children children-li children-sort-" >
2022-11-08 14:43:28 +00:00
< li > < a href = "../shortcodes/children/children-3/test3/index.html" > page 3-1< / a > < / li >
2022-04-02 13:30:16 +00:00
< / ul >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< section >
2022-10-07 18:46:19 +00:00
< h1 class = "a11y-only" > Subsections of page 3< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "page-3-1" > page 3-1< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > This is a plain demo child page.< / p >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< / section >
< / section >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "expand" > Expand< / h1 >
2022-07-05 22:16:52 +00:00
2022-06-05 17:32:37 +00:00
< p > The < code > expand< / code > shortcode displays an expandable/collapsible section of text.< / p >
2022-04-02 13:30:16 +00:00
< div class = "expand" >
2023-02-13 22:22:23 +00:00
< input type = "checkbox" id = "expand-0" aria-controls = "expandcontent-0" >
< label class = "expand-label" for = "expand-0" >
2022-04-02 13:30:16 +00:00
< i class = "fas fa-chevron-down" > < / i >
2023-02-09 00:02:54 +00:00
< i class = "fas fa-chevron-right" > < / i >
2022-06-05 17:32:37 +00:00
Expand me...
2023-02-03 07:58:48 +00:00
< / label >
2023-02-13 22:22:23 +00:00
< div id = "expandcontent-0" class = "expand-content" >
2022-06-05 17:32:37 +00:00
Thank you!
< / div >
< / div >
2023-02-03 07:58:48 +00:00
< 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" >
2023-02-04 15:02:34 +00:00
< p > This only works in modern browsers flawlessly. While Internet Explorer 11 has issues in displaying it, the functionality still works.< / p >
2023-02-03 07:58:48 +00:00
< / div >
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-10-31 14:06:51 +00:00
< p > While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.< / p >
2022-04-02 13:30:16 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
2022-06-22 22:08:50 +00:00
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > expand< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Expand me..." < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Thank< / span > < span class = "nx" > you< / span > < span class = "p" > !{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > expand< / span > < span class = "s" > " Expand me..." < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Thank< / span > < span class = "nx" > you< / span > < span class = "p" > !{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/expand.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" > " title" < / span > < span class = "s" > " Expand me..." < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "s" > " Thank you!" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< 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 > title< / strong > < / td >
< td style = "text-align:left" > 1< / td >
< td style = "text-align:left" > < code > " Expand me..." < / code > < / td >
2022-10-31 14:06:51 +00:00
< td style = "text-align:left" > Arbitrary text to appear next to the expand/collapse icon.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > open< / strong > < / td >
< td style = "text-align:left" > 2< / td >
< td style = "text-align:left" > < code > false< / code > < / td >
< td style = "text-align:left" > When < code > true< / code > the content text will be initially shown as expanded.< / td >
< / tr >
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-10-31 14:06:51 +00:00
< td style = "text-align:left" > Arbitrary text to be displayed on expand.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< / tbody >
< / table >
< h2 id = "examples" > Examples< / h2 >
< h3 id = "all-defaults" > All Defaults< / h3 >
< 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" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > Yes< / span > < span class = "p" > ,< / span > < span class = "nx" > you< / span > < span class = "nx" > did< / span > < span class = "nx" > it< / span > < span class = "p" > !{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-04-02 13:30:16 +00:00
< div class = "expand" >
2023-02-13 22:22:23 +00:00
< input type = "checkbox" id = "expand-3" aria-controls = "expandcontent-3" >
< label class = "expand-label" for = "expand-3" >
2022-04-02 13:30:16 +00:00
< i class = "fas fa-chevron-down" > < / i >
2023-02-09 00:02:54 +00:00
< i class = "fas fa-chevron-right" > < / i >
2022-04-02 13:30:16 +00:00
Expand me...
2023-02-03 07:58:48 +00:00
< / label >
2023-02-13 22:22:23 +00:00
< div id = "expandcontent-3" class = "expand-content" >
2022-06-05 17:32:37 +00:00
Yes, you did it!
2022-04-02 13:30:16 +00:00
< / div >
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "initially-expanded" > Initially Expanded< / h3 >
< 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" > expand< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Expand me..." < / span > < span class = "nx" > open< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span > < span class = "nx" > No< / span > < span class = "nx" > need< / span > < span class = "nx" > to< / span > < span class = "nx" > press< / span > < span class = "nx" > you< / span > < span class = "p" > !{{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div >
2023-02-03 07:58:48 +00:00
< div class = "expand" >
2023-02-13 22:22:23 +00:00
< input type = "checkbox" id = "expand-4" aria-controls = "expandcontent-4" checked >
< label class = "expand-label" for = "expand-4" >
2022-04-02 13:30:16 +00:00
< i class = "fas fa-chevron-down" > < / i >
2023-02-09 00:02:54 +00:00
< i class = "fas fa-chevron-right" > < / i >
2022-04-02 13:30:16 +00:00
Expand me...
2023-02-03 07:58:48 +00:00
< / label >
2023-02-13 22:22:23 +00:00
< div id = "expandcontent-4" class = "expand-content" >
2022-06-05 17:32:37 +00:00
No need to press you!
2022-04-02 13:30:16 +00:00
< / div >
< / div >
2022-06-05 17:32:37 +00:00
< h3 id = "arbitrary-text" > Arbitrary Text< / h3 >
< 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" > expand< / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Show me almost endless possibilities" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > You< / span > < span class = "nx" > can< / span > < span class = "nx" > add< / span > < span class = "nx" > standard< / span > < span class = "nx" > markdown< / span > < span class = "nx" > syntax< / span > < span class = "p" > :< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > multiple< / span > < span class = "nx" > paragraphs< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > bullet< / span > < span class = "nx" > point< / span > < span class = "nx" > lists< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > _emphasized_< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "nx" > bold< / span > < span class = "o" > **< / span > < span class = "nx" > and< / span > < span class = "nx" > even< / span > < span class = "o" > **< / span > < span class = "nx" > _bold< / span > < span class = "nx" > emphasized_< / span > < span class = "o" > **< / span > < span class = "nx" > text< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "p" > [< / span > < span class = "nx" > links< / span > < span class = "p" > ](< / span > < span class = "nx" > https< / span > < span class = "p" > :< / span > < span class = "c1" > //example.com)
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c1" > < / span > < span class = "o" > -< / span > < span class = "nx" > etc< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```plaintext
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ...and even source code
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-10-31 14:06:51 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > > < / span > < span class = "nx" > the< / span > < span class = "nx" > possibilities< / span > < span class = "nx" > are< / span > < span class = "nf" > endless< / span > < span class = "p" > (< / span > < span class = "nx" > almost< / span > < span class = "o" > -< / span > < span class = "nx" > including< / span > < span class = "nx" > other< / span > < span class = "nx" > shortcodes< / span > < span class = "nx" > may< / span > < span class = "nx" > or< / span > < span class = "nx" > may< / span > < span class = "nx" > not< / span > < span class = "nx" > work< / span > < span class = "p" > )< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > expand< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "expand" >
2023-02-13 22:22:23 +00:00
< input type = "checkbox" id = "expand-5" aria-controls = "expandcontent-5" >
< label class = "expand-label" for = "expand-5" >
2022-04-02 13:30:16 +00:00
< i class = "fas fa-chevron-down" > < / i >
2023-02-09 00:02:54 +00:00
< i class = "fas fa-chevron-right" > < / i >
2022-05-23 13:00:05 +00:00
Show me almost endless possibilities
2023-02-03 07:58:48 +00:00
< / label >
2023-02-13 22:22:23 +00:00
< div id = "expandcontent-5" class = "expand-content" >
2022-05-23 13:00:05 +00:00
< p > You can add standard markdown syntax:< / p >
2022-04-02 13:30:16 +00:00
< ul >
< li > multiple paragraphs< / li >
< li > bullet point lists< / li >
< li > < em > emphasized< / em > , < strong > bold< / strong > and even < strong > < em > bold emphasized< / em > < / strong > text< / li >
2022-12-23 11:24:54 +00:00
< li > < a href = "https://example.com" target = "_blank" > links< / a > < / li >
2022-04-02 13:30:16 +00:00
< li > etc.< / li >
< / ul >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ...and even source code
< / span > < / span > < / code > < / pre > < / div > < blockquote >
2022-10-31 14:06:51 +00:00
< p > the possibilities are endless (almost - including other shortcodes may or may not work)< / p >
2022-04-02 13:30:16 +00:00
< / blockquote >
< / div >
< / div >
< footer class = "footline" >
< / footer >
< / article >
2022-12-02 17:32:53 +00:00
< article class = "default" >
< h1 id = "icon" > Icon< / h1 >
2023-01-24 22:59:44 +00:00
< p > The < code > icon< / code > shortcode displays icons using the < a href = "https://fontawesome.com" target = "_blank" > Font Awesome< / a > library.< / p >
2022-12-02 17:32:53 +00:00
< 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 >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-12-02 17:32:53 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-12-02 17:32:53 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-12-02 17:32:53 +00:00
< button
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-12-02 17:32:53 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-12-02 17:32:53 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-12-02 17:32:53 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-12-02 17:32:53 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
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 = "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 >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
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 = "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 >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
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 = "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 >
2022-12-16 17:42:17 +00:00
< 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 >
2022-12-02 17:32:53 +00:00
< / tr >
< / tbody >
< / table >
2022-12-02 18:27:40 +00:00
< h3 id = "finding-an-icon" > Finding an icon< / h3 >
2022-12-23 11:24:54 +00:00
< 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 >
2022-12-02 18:27:40 +00:00
< h3 id = "customising-icons" > Customising Icons< / h3 >
2022-12-02 17:32:53 +00:00
< 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 >
2022-12-23 11:24:54 +00:00
< 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 >
2022-12-02 17:32:53 +00:00
< 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" > 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 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "include" > Include< / h1 >
2022-07-05 22:16:52 +00:00
2022-06-05 17:32:37 +00:00
< p > The < code > include< / code > shortcode includes other files from your project inside of the current page.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials.< / p >
2022-06-05 17:32:37 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
2022-06-22 22:08:50 +00:00
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > include< / span > < span class = "nx" > file< / span > < span class = "p" > =< / span > < span class = "s" > " shortcodes/INCLUDE_ME.md" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > include< / span > < span class = "s" > " shortcodes/INCLUDE_ME.md" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/include .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" > " file" < / span > < span class = "s" > " shortcodes/INCLUDE_ME.md" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< p > The included files can even contain Markdown and will be taken into account when generating the table of contents.< / p >
< 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 > file< / strong > < / td >
< td style = "text-align:left" > 1< / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-12-23 11:24:54 +00:00
< td style = "text-align:left" > The path to the file to be included. Path resolution adheres to < a href = "https://gohugo.io/functions/readfile/" target = "_blank" > Hugo’ s build-in < code > readFile< / code > function< / a > < / td >
2022-06-05 17:32:37 +00:00
< / tr >
< tr >
2022-06-23 11:25:28 +00:00
< td style = "text-align:left" > < strong > hidefirstheading< / strong > < / td >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > 2< / td >
2022-06-23 11:25:28 +00:00
< td style = "text-align:left" > < code > false< / code > < / td >
< td style = "text-align:left" > When < code > true< / code > and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< / tbody >
< / table >
2022-04-02 13:30:16 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-10-31 14:06:51 +00:00
< h3 id = "arbitrary-content" > Arbitrary Content< / h3 >
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > include< / span > < span class = "s" > " shortcodes/INCLUDE_ME.md" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-23 11:28:22 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > You can add standard markdown syntax:< / p >
2022-04-02 13:30:16 +00:00
< ul >
< li > multiple paragraphs< / li >
< li > bullet point lists< / li >
< li > < em > emphasized< / em > , < strong > bold< / strong > and even < strong > < em > bold emphasized< / em > < / strong > text< / li >
2022-12-23 11:24:54 +00:00
< li > < a href = "https://example.com" target = "_blank" > links< / a > < / li >
2022-04-02 13:30:16 +00:00
< li > etc.< / li >
< / ul >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ...and even source code
< / span > < / span > < / code > < / pre > < / div > < blockquote >
2022-10-31 14:06:51 +00:00
< p > the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)< / p >
2022-04-02 13:30:16 +00:00
< / blockquote >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "math" > Math< / h1 >
2022-07-05 22:16:52 +00:00
2022-12-23 11:24:54 +00:00
< p > The < code > math< / code > shortcode generates beautiful formatted math and chemical formulae using the < a href = "https://mathjax.org/" target = "_blank" > MathJax< / a > library.< / p >
2022-07-02 12:20:53 +00:00
< span class = "math align-center" >
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span >
2022-07-02 22:46:26 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-07-02 22:46:26 +00:00
< p > This only works in modern browsers.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-07-02 22:46:26 +00:00
< / div >
2022-07-02 12:20:53 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-10-04 13:36:17 +00:00
< p > While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Math codefences (eg. GitHub) and so your markdown becomes more portable.< / p >
2022-07-02 12:20:53 +00:00
< p > You are free to also call this shortcode from your own partials.< / p >
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-12-16 17:42:17 +00:00
< p > To use codefence syntax you have to turn off < code > guessSyntax< / code > for the < code > markup.highlight< / code > setting (< a href = "#configuration" > see the configuration section< / a > ).< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-07-02 12:20:53 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-07-02 12:20:53 +00:00
< div class = "tab-nav" >
< button
data-tab-item="codefence"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-07-02 12:20:53 +00:00
onclick="switchTab('shortcode-parameter','codefence')"
2023-01-29 16:05:10 +00:00
>
< span > codefence< / span > < / button >
2022-07-02 12:20:53 +00:00
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-07-02 12:20:53 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-07-02 12:20:53 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-07-02 12:20:53 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-07-02 12:20:53 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="codefence"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-10-31 14:31:20 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ```math { align=" center" }
< / span > < / span > < span class = "line" > < span class = "cl" > $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span > < / span > < span class = "line" > < span class = "cl" > ```
2022-07-02 12:20:53 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-10-31 14:31:20 +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 = "p" > {{< < / span > < span class = "nx" > math< / span > < span class = "nx" > align< / span > < span class = "p" > =< / span > < span class = "s" > " center" < / span > < span class = "p" > > }}< / span >
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > $$\< / span > < span class = "nf" > left< / span > < span class = "p" > (< / span > < span class = "err" > \< / span > < span class = "nx" > sum_< / span > < span class = "p" > {< / span > < span class = "nx" > k< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span > < span class = "p" > }^< / span > < span class = "nx" > n< / span > < span class = "nx" > a_k< / span > < span class = "nx" > b_k< / span > < span class = "err" > \< / span > < span class = "nx" > right< / span > < span class = "p" > )^< / span > < span class = "mi" > 2< / span > < span class = "err" > \< / span > < span class = "nx" > leq< / span > < span class = "err" > \< / span > < span class = "nf" > left< / span > < span class = "p" > (< / span > < span class = "err" > \< / span > < span class = "nx" > sum_< / span > < span class = "p" > {< / span > < span class = "nx" > k< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span > < span class = "p" > }^< / span > < span class = "nx" > n< / span > < span class = "nx" > a_k< / span > < span class = "p" > ^< / span > < span class = "mi" > 2< / span > < span class = "err" > \< / span > < span class = "nx" > right< / span > < span class = "p" > )< / span > < span class = "err" > \< / span > < span class = "nf" > left< / span > < span class = "p" > (< / span > < span class = "err" > \< / span > < span class = "nx" > sum_< / span > < span class = "p" > {< / span > < span class = "nx" > k< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span > < span class = "p" > }^< / span > < span class = "nx" > n< / span > < span class = "nx" > b_k< / span > < span class = "p" > ^< / span > < span class = "mi" > 2< / span > < span class = "err" > \< / span > < span class = "nx" > right< / span > < span class = "p" > )< / span > < span class = "err" > $$< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > math< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-07-02 12:20: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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/math.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" > " content" < / span > < span class = "s" > " $$left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$" < / span >
2022-10-31 14:31:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " align" < / span > < span class = "s" > " center" < / span >
2022-07-02 12:20:53 +00:00
< / 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" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:left" > < strong > align< / strong > < / td >
< td style = "text-align:left" > < code > center< / code > < / td >
< td style = "text-align:left" > Allowed values are < code > left< / code > , < code > center< / code > or < code > right< / code > .< / td >
< / tr >
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > Your formuale.< / td >
< / tr >
< / tbody >
< / table >
< h2 id = "configuration" > Configuration< / h2 >
< p > MathJax is configured with default settings. You can customize MathJax’ s default settings for all of your files thru a JSON object in your < code > config.toml< / code > or override these settings per page thru your pages frontmatter.< / p >
< p > The JSON object of your < code > config.toml< / code > / frontmatter is forwarded into MathJax’ s configuration object.< / p >
2022-12-23 11:24:54 +00:00
< p > See < a href = "https://docs.mathjax.org/en/latest/options/index.html" target = "_blank" > MathJax documentation< / a > for all allowed settings.< / p >
2022-07-02 12:20:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-07-02 12:20:53 +00:00
< p > To use codefence syntax you have to turn off < code > guessSyntax< / code > for the < code > markup.highlight< / code > setting.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-07-02 12:20:53 +00:00
< / div >
< h3 id = "global-configuration-file" > Global Configuration File< / h3 >
< div class = "highlight" > < 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" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mathJaxInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" chtml\" : { \" displayAlign\" : \" left\" } }" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > markup< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > markup< / span > < span class = "p" > .< / span > < span class = "nx" > highlight< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # if `guessSyntax = true`, there will be no unstyled code even if no language< / span >
2022-10-04 13:36:17 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # was given BUT Mermaid and Math codefences will not work anymore! So this is a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # mandatory setting for your site if you want to use Math codefences< / span >
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > guessSyntax< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < / code > < / pre > < / div > < h3 id = "pages-frontmatter" > Page’ s Frontmatter< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mathJaxInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" chtml\" : { \" displayAlign\" : \" left\" } }" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < / code > < / pre > < / div > < h2 id = "examples" > Examples< / h2 >
< h3 id = "inline-math" > Inline Math< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > Inline math is generated if you use a single < span class = "sb" > `$`< / span > as a delimiter around your formulae: {{< span class = "p" > < < / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}$\sqrt{3}${{< span class = "p" > < < / span > < span class = "p" > /< / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}
< / span > < / span > < / code > < / pre > < / div > < p > Inline math is generated if you use a single < code > $< / code > as a delimiter around your formulae:
< span class = "math align-center" > $\sqrt{3}$< / span > < / p >
2022-11-05 12:01:19 +00:00
< h3 id = "blocklevel-math-with-right-alignment" > Blocklevel Math with Right Alignment< / h3 >
2022-07-02 12:20:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > If you delimit your formulae by two consecutive < span class = "sb" > `$$`< / span > it generates a new block.
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-11-05 12:01:19 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > {{< span class = "p" > < < / span > < span class = "nt" > math< / span > < span class = "na" > align< / span > < span class = "o" > =< / span > < span class = "s" > " right" < / span > < span class = "p" > > < / span > }}
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span > < / span > < span class = "line" > < span class = "cl" > {{< span class = "p" > < < / span > < span class = "p" > /< / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}
< / span > < / span > < / code > < / pre > < / div > < p > If you delimit your formulae by two consecutive < code > $$< / code > it generates a new block.< / p >
2022-11-05 12:01:19 +00:00
< span class = "math align-right" >
2022-07-02 12:20:53 +00:00
$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span >
< h3 id = "codefence" > Codefence< / h3 >
2023-01-14 00:40:32 +00:00
< p > You can also use codefences.< / p >
2022-07-02 12:20:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > < span class = "s" > ```math
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > < / span > $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-07-02 22:36:23 +00:00
< span class = "math align-center" > $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$< / span > < h3 id = "chemical-formulae" > Chemical Formulae< / h3 >
2022-07-02 12:20:53 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > {{< span class = "p" > < < / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}
< / span > < / span > < span class = "line" > < span class = "cl" > $$\ce{Hg^2+ -> [I-] HgI2 -> [I-] [Hg^{II}I4]^2-}$$
< / span > < / span > < span class = "line" > < span class = "cl" > {{< span class = "p" > < < / span > < span class = "p" > /< / span > < span class = "nt" > math< / span > < span class = "p" > > < / span > }}
< / span > < / span > < / code > < / pre > < / div >
< span class = "math align-center" >
$$\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}$$
< / span >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "mermaid" > Mermaid< / h1 >
2022-07-05 22:16:52 +00:00
2022-12-23 11:24:54 +00:00
< p > The < code > mermaid< / code > shortcode generates diagrams and flowcharts from text, in a similar manner as Markdown using the < a href = "https://mermaidjs.github.io/" target = "_blank" > Mermaid< / a > library.< / p >
2022-06-05 17:32:37 +00:00
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-06-05 17:32:37 +00:00
graph LR;
2022-10-07 18:46:19 +00:00
If --> Then
Then --> Else
2022-06-05 17:32:37 +00:00
< / div >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > This only works in modern browsers.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > Warning< / div >
< div class = "box-content" >
2022-12-23 11:24:54 +00:00
< p > Due to limitations with < a href = "https://github.com/mermaid-js/mermaid/issues/1846" target = "_blank" > Mermaid< / a > , it is currently not possible to use Mermaid code fences in an initially collapsed < code > expand< / code > shortcode. This is a know issue and < a href = "https://github.com/McShelby/hugo-theme-relearn/issues/187" target = "_blank" > can’ t be fixed by this theme< / a > .< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter it is recommended to use codefences instead. This is because more and more other software supports Mermaid codefences (eg. GitHub) and so your markdown becomes more portable.< / p >
< p > You are free to also call this shortcode from your own partials.< / p >
2022-06-05 17:32:37 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-12-16 17:42:17 +00:00
< p > To use codefence syntax you have to turn off < code > guessSyntax< / code > for the < code > markup.highlight< / code > setting (< a href = "#configuration" > see the configuration section< / a > ).< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
data-tab-item="codefence"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','codefence')"
2023-01-29 16:05:10 +00:00
>
< span > codefence< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="codefence"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2023-02-05 10:13:50 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-md" data-lang = "md" > < span class = "line" > < span class = "cl" > ```mermaid { align=" center" zoom=" true" }
2022-10-31 14:17:29 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > graph LR;
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > If --> Then
< / span > < / span > < span class = "line" > < span class = "cl" > Then --> Else
2022-10-31 14:17:29 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ```
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2023-02-05 10:13:50 +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 = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "nx" > align< / span > < span class = "p" > =< / span > < span class = "s" > " center" < / span > < span class = "nx" > zoom< / span > < span class = "p" > =< / span > < span class = "s" > " true" < / span > < span class = "p" > > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > graph< / span > < span class = "nx" > LR< / span > < span class = "p" > ;< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > If< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > Then< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Then< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > Else< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/mermaid.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" > " content" < / span > < span class = "s" > " graph LR;\nIf --> Then\nThen --> Else" < / span >
2022-10-31 14:17:29 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " align" < / span > < span class = "s" > " center" < / span >
2023-02-05 10:13:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " zoom" < / span > < span class = "s" > " true" < / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-22 22:08:50 +00:00
< p > The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.< / p >
2022-06-05 17:32:37 +00:00
< h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / 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 > align< / strong > < / td >
< td style = "text-align:left" > < code > center< / code > < / td >
< td style = "text-align:left" > Allowed values are < code > left< / code > , < code > center< / code > or < code > right< / code > .< / td >
< / tr >
< tr >
2023-02-05 10:13:50 +00:00
< td style = "text-align:left" > < strong > zoom< / strong > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > Whether the graph is pan- and zoomable.< br > < br > If not set the value is determined by the < code > mermaidZoom< / code > setting of the < a href = "#global-configuration-file" > site< / a > or the < a href = "#pages-frontmatter" > pages frontmatter< / a > or < code > false< / code > if not set at all.< br > < br > - < code > false< / code > : no pan or zoom< br > - < code > true< / code > : pan and zoom active< / td >
< / tr >
< tr >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-10-04 13:36:17 +00:00
< td style = "text-align:left" > Your Mermaid graph.< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< / tbody >
< / table >
< h2 id = "configuration" > Configuration< / h2 >
2022-12-23 11:24:54 +00:00
< p > Mermaid is configured with default settings. You can customize Mermaid’ s default settings for all of your files thru a JSON object in your < code > config.toml< / code > , override these settings per page thru your pages frontmatter or override these setting per diagramm thru < a href = "https://mermaid-js.github.io/mermaid/#/directives?id=directives" target = "_blank" > diagram directives< / a > .< / p >
2022-06-05 17:32:37 +00:00
< p > The JSON object of your < code > config.toml< / code > / frontmatter is forwarded into Mermaid’ s < code > mermaid.initialize()< / code > function.< / p >
2022-12-23 11:24:54 +00:00
< p > See < a href = "https://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults" target = "_blank" > Mermaid documentation< / a > for all allowed settings.< / p >
2022-06-05 17:32:37 +00:00
< p > The < code > theme< / code > setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in < code > config.toml< / code > , frontmatter or diagram directives.< / p >
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-06-05 17:32:37 +00:00
< p > To use codefence syntax you have to turn off < code > guessSyntax< / code > for the < code > markup.highlight< / code > setting.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< / div >
< h3 id = "global-configuration-file" > Global Configuration File< / h3 >
< div class = "highlight" > < 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" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" theme\" : \" dark\" }" < / span >
2023-02-05 10:13:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidZoom< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > markup< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > markup< / span > < span class = "p" > .< / span > < span class = "nx" > highlight< / span > < span class = "p" > ]< / span >
2022-07-02 12:20:53 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # if `guessSyntax = true`, there will be no unstyled code even if no language< / span >
2022-10-04 13:36:17 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # was given BUT Mermaid and Math codefences will not work anymore! So this is a< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # mandatory setting for your site if you want to use Mermaid codefences< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > guessSyntax< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < / code > < / pre > < / div > < h3 id = "pages-frontmatter" > Page’ s Frontmatter< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" theme\" : \" dark\" }" < / span >
2023-02-05 10:13:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > mermaidZoom< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
< / span > < / span > < / code > < / pre > < / div > < h2 id = "examples" > Examples< / h2 >
< h3 id = "flowchart-with-non-default-mermaid-theme" > Flowchart with Non-Default Mermaid Theme< / h3 >
2022-11-05 12:01:19 +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 = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > %%< / span > < span class = "p" > {< / span > < span class = "nx" > init< / span > < span class = "p" > :{< / span > < span class = "s" > " theme" < / span > < span class = "p" > :< / span > < span class = "s" > " forest" < / span > < span class = "p" > }}< / span > < span class = "o" > %%< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > graph< / span > < span class = "nx" > LR< / span > < span class = "p" > ;< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "p" > [< / span > < span class = "nx" > Hard< / span > < span class = "nx" > edge< / span > < span class = "p" > ]< / span > < span class = "o" > --< / span > < span class = "p" > > |< / span > < span class = "nx" > Link< / span > < span class = "nx" > text< / span > < span class = "p" > |< / span > < span class = "nf" > B< / span > < span class = "p" > (< / span > < span class = "nx" > Round< / span > < span class = "nx" > edge< / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > B< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > C< / span > < span class = "p" > {< < / span > < span class = "nx" > strong< / span > < span class = "p" > > < / span > < span class = "nx" > Decision< / span > < span class = "p" > < < / span > < span class = "o" > /< / span > < span class = "nx" > strong< / span > < span class = "p" > > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > C< / span > < span class = "o" > --< / span > < span class = "p" > > |< / span > < span class = "nx" > One< / span > < span class = "p" > |< / span > < span class = "nx" > D< / span > < span class = "p" > [< / span > < span class = "nx" > Result< / span > < span class = "nx" > one< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > C< / span > < span class = "o" > --< / span > < span class = "p" > > |< / span > < span class = "nx" > Two< / span > < span class = "p" > |< / span > < span class = "nx" > E< / span > < span class = "p" > [< / span > < span class = "nx" > Result< / span > < span class = "nx" > two< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-10-07 18:46:19 +00:00
%%{init:{" theme" :" forest" }}%%
2022-06-05 17:32:37 +00:00
graph LR;
2022-10-07 18:46:19 +00:00
A[Hard edge] --> |Link text| B(Round edge)
B --> C{< strong> Decision< /strong> }
C --> |One| D[Result one]
C --> |Two| E[Result two]
2022-04-02 13:30:16 +00:00
< / div >
2022-11-18 23:02:20 +00:00
< h3 id = "sequence-diagram-with-configuration-directive" > Sequence Diagram with Configuration Directive< / h3 >
< 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" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > %%< / span > < span class = "p" > {< / span > < span class = "nx" > init< / span > < span class = "p" > :{< / span > < span class = "s" > " fontFamily" < / span > < span class = "p" > :< / span > < span class = "s" > " monospace" < / span > < span class = "p" > ,< / span > < span class = "s" > " sequence" < / span > < span class = "p" > :{< / span > < span class = "s" > " showSequenceNumbers" < / span > < span class = "p" > :< / span > < span class = "kc" > true< / span > < span class = "p" > }}}< / span > < span class = "o" > %%< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > sequenceDiagram< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Alice< / span > < span class = "o" > -> > < / span > < span class = "nx" > John< / span > < span class = "p" > :< / span > < span class = "nx" > Hello< / span > < span class = "nx" > John< / span > < span class = "p" > ,< / span > < span class = "nx" > how< / span > < span class = "nx" > are< / span > < span class = "nx" > you< / span > < span class = "err" > ?< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > loop< / span > < span class = "nx" > Healthcheck< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > John< / span > < span class = "o" > -> > < / span > < span class = "nx" > John< / span > < span class = "p" > :< / span > < span class = "nx" > Fight< / span > < span class = "nx" > against< / span > < span class = "nx" > hypochondria< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > end< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Note< / span > < span class = "nx" > right< / span > < span class = "nx" > of< / span > < span class = "nx" > John< / span > < span class = "p" > :< / span > < span class = "nx" > Rational< / span > < span class = "nx" > thoughts< / span > < span class = "p" > !< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > John< / span > < span class = "o" > --> > < / span > < span class = "nx" > Alice< / span > < span class = "p" > :< / span > < span class = "nx" > Great< / span > < span class = "p" > !< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > John< / span > < span class = "o" > -> > < / span > < span class = "nx" > Bob< / span > < span class = "p" > :< / span > < span class = "nx" > How< / span > < span class = "nx" > about< / span > < span class = "nx" > you< / span > < span class = "err" > ?< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Bob< / span > < span class = "o" > --> > < / span > < span class = "nx" > John< / span > < span class = "p" > :< / span > < span class = "nx" > Jolly< / span > < span class = "nx" > good< / span > < span class = "p" > !< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
%%{init:{" fontFamily" :" monospace" , " sequence" :{" showSequenceNumbers" :true}}}%%
sequenceDiagram
Alice-> > John: Hello John, how are you?
loop Healthcheck
John-> > John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John--> > Alice: Great!
John-> > Bob: How about you?
Bob--> > John: Jolly good!
< / div >
2022-11-17 22:36:34 +00:00
< h3 id = "class-diagram-with-codefence-syntax" > Class Diagram with Codefence Syntax< / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "s" > ```mermaid
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > classDiagram
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal < |-- Duck
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal < |-- Fish
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal < |-- Zebra
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal : +int age
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal : +String gender
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal: +isMammal()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Animal: +mate()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > class Duck{
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +String beakColor
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +swim()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +quack()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > class Fish{
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > -int sizeInFeet
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > -canEat()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > class Zebra{
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +bool is_wild
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > +run()
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" > classDiagram
2022-11-17 22:36:34 +00:00
Animal < |-- Duck
Animal < |-- Fish
Animal < |-- Zebra
Animal : + int age
Animal : + String gender
Animal: + isMammal()
Animal: + mate()
class Duck{
+ String beakColor
+ swim()
+ quack()
}
class Fish{
-int sizeInFeet
-canEat()
}
class Zebra{
+ bool is_wild
+ run()
}< / div > < h3 id = "state-diagram-aligned-to-the-right" > State Diagram Aligned to the Right< / h3 >
< 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" > mermaid< / span > < span class = "nx" > align< / span > < span class = "p" > =< / span > < span class = "s" > " right" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > stateDiagram< / span > < span class = "o" > -< / span > < span class = "nx" > v2< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > open< / span > < span class = "p" > :< / span > < span class = "nx" > Open< / span > < span class = "nx" > Door< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > closed< / span > < span class = "p" > :< / span > < span class = "nx" > Closed< / span > < span class = "nx" > Door< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > locked< / span > < span class = "p" > :< / span > < span class = "nx" > Locked< / span > < span class = "nx" > Door< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > open< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > closed< / span > < span class = "p" > :< / span > < span class = "nx" > Close< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > closed< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > locked< / span > < span class = "p" > :< / span > < span class = "nx" > Lock< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > locked< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > closed< / span > < span class = "p" > :< / span > < span class = "nx" > Unlock< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > closed< / span > < span class = "o" > --< / span > < span class = "p" > > < / span > < span class = "nx" > open< / span > < span class = "p" > :< / span > < span class = "nx" > Open< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-right zoom" >
2022-11-17 22:36:34 +00:00
stateDiagram-v2
open: Open Door
closed: Closed Door
locked: Locked Door
open --> closed: Close
closed --> locked: Lock
locked --> closed: Unlock
closed --> open: Open
< / div >
2022-11-18 23:02:20 +00:00
< h3 id = "entity-relationship-model" > Entity Relationship Model< / h3 >
2022-04-02 13:30:16 +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 = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-11-18 23:02:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > erDiagram< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > CUSTOMER< / span > < span class = "p" > }|..|{< / span > < span class = "nx" > DELIVERY< / span > < span class = "o" > -< / span > < span class = "nx" > ADDRESS< / span > < span class = "p" > :< / span > < span class = "nx" > has< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > CUSTOMER< / span > < span class = "o" > ||--< / span > < span class = "nx" > o< / span > < span class = "p" > {< / span > < span class = "nx" > ORDER< / span > < span class = "p" > :< / span > < span class = "nx" > places< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > CUSTOMER< / span > < span class = "o" > ||--< / span > < span class = "nx" > o< / span > < span class = "p" > {< / span > < span class = "nx" > INVOICE< / span > < span class = "p" > :< / span > < span class = "s" > " liable for" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > DELIVERY< / span > < span class = "o" > -< / span > < span class = "nx" > ADDRESS< / span > < span class = "o" > ||--< / span > < span class = "nx" > o< / span > < span class = "p" > {< / span > < span class = "nx" > ORDER< / span > < span class = "p" > :< / span > < span class = "nx" > receives< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > INVOICE< / span > < span class = "o" > ||--< / span > < span class = "p" > |{< / span > < span class = "nx" > ORDER< / span > < span class = "p" > :< / span > < span class = "nx" > covers< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > ORDER< / span > < span class = "o" > ||--< / span > < span class = "p" > |{< / span > < span class = "nx" > ORDER< / span > < span class = "o" > -< / span > < span class = "nx" > ITEM< / span > < span class = "p" > :< / span > < span class = "nx" > includes< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > PRODUCT< / span > < span class = "o" > -< / span > < span class = "nx" > CATEGORY< / span > < span class = "o" > ||--< / span > < span class = "p" > |{< / span > < span class = "nx" > PRODUCT< / span > < span class = "p" > :< / span > < span class = "nx" > contains< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > PRODUCT< / span > < span class = "o" > ||--< / span > < span class = "nx" > o< / span > < span class = "p" > {< / span > < span class = "nx" > ORDER< / span > < span class = "o" > -< / span > < span class = "nx" > ITEM< / span > < span class = "p" > :< / span > < span class = "s" > " ordered in" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
erDiagram
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
CUSTOMER ||--o{ ORDER : places
CUSTOMER ||--o{ INVOICE : " liable for"
DELIVERY-ADDRESS ||--o{ ORDER : receives
INVOICE ||--|{ ORDER : covers
ORDER ||--|{ ORDER-ITEM : includes
PRODUCT-CATEGORY ||--|{ PRODUCT : contains
PRODUCT ||--o{ ORDER-ITEM : " ordered in"
< / div >
< h3 id = "user-journey" > User Journey< / h3 >
< 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" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > journey< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "nx" > My< / span > < span class = "nx" > working< / span > < span class = "nx" > day< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "nx" > Go< / span > < span class = "nx" > to< / span > < span class = "nx" > work< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Make< / span > < span class = "nx" > tea< / span > < span class = "p" > :< / span > < span class = "mi" > 5< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Go< / span > < span class = "nx" > upstairs< / span > < span class = "p" > :< / span > < span class = "mi" > 3< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Do< / span > < span class = "nx" > work< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span > < span class = "p" > ,< / span > < span class = "nx" > Cat< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "nx" > Go< / span > < span class = "nx" > home< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Go< / span > < span class = "nx" > downstairs< / span > < span class = "p" > :< / span > < span class = "mi" > 5< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Sit< / span > < span class = "nx" > down< / span > < span class = "p" > :< / span > < span class = "mi" > 3< / span > < span class = "p" > :< / span > < span class = "nx" > Me< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
journey
title My working day
section Go to work
Make tea: 5: Me
Go upstairs: 3: Me
Do work: 1: Me, Cat
section Go home
Go downstairs: 5: Me
Sit down: 3: Me
2022-04-02 13:30:16 +00:00
< / div >
2022-11-17 22:36:34 +00:00
< h3 id = "gantt-chart" > GANTT Chart< / h3 >
2022-04-02 13:30:16 +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 = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > gantt< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > dateFormat< / span > < span class = "nx" > YYYY< / span > < span class = "o" > -< / span > < span class = "nx" > MM< / span > < span class = "o" > -< / span > < span class = "nx" > DD< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "nx" > Adding< / span > < span class = "nx" > GANTT< / span > < span class = "nx" > diagram< / span > < span class = "nx" > functionality< / span > < span class = "nx" > to< / span > < span class = "nx" > Mermaid< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "nx" > A< / span > < span class = "nx" > section< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Completed< / span > < span class = "nx" > task< / span > < span class = "p" > :< / span > < span class = "nx" > done< / span > < span class = "p" > ,< / span > < span class = "nx" > des1< / span > < span class = "p" > ,< / span > < span class = "mi" > 2014< / span > < span class = "o" > -< / span > < span class = "mo" > 01< / span > < span class = "o" > -< / span > < span class = "mo" > 06< / span > < span class = "p" > ,< / span > < span class = "mi" > 2014< / span > < span class = "o" > -< / span > < span class = "mo" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 08< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Active< / span > < span class = "nx" > task< / span > < span class = "p" > :< / span > < span class = "nx" > active< / span > < span class = "p" > ,< / span > < span class = "nx" > des2< / span > < span class = "p" > ,< / span > < span class = "mi" > 2014< / span > < span class = "o" > -< / span > < span class = "mo" > 01< / span > < span class = "o" > -< / span > < span class = "mi" > 09< / span > < span class = "p" > ,< / span > < span class = "mi" > 3< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Future< / span > < span class = "nx" > task< / span > < span class = "p" > :< / span > < span class = "nx" > des3< / span > < span class = "p" > ,< / span > < span class = "nx" > after< / span > < span class = "nx" > des2< / span > < span class = "p" > ,< / span > < span class = "mi" > 5< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Future< / span > < span class = "nx" > task2< / span > < span class = "p" > :< / span > < span class = "nx" > des4< / span > < span class = "p" > ,< / span > < span class = "nx" > after< / span > < span class = "nx" > des3< / span > < span class = "p" > ,< / span > < span class = "mi" > 5< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > section< / span > < span class = "nx" > Critical< / span > < span class = "nx" > tasks< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Completed< / span > < span class = "nx" > task< / span > < span class = "nx" > in< / span > < span class = "nx" > the< / span > < span class = "nx" > critical< / span > < span class = "nx" > line< / span > < span class = "p" > :< / span > < span class = "nx" > crit< / span > < span class = "p" > ,< / span > < span class = "nx" > done< / span > < span class = "p" > ,< / span > < span class = "mi" > 2014< / span > < span class = "o" > -< / span > < span class = "mo" > 01< / span > < span class = "o" > -< / span > < span class = "mo" > 06< / span > < span class = "p" > ,< / span > < span class = "mi" > 24< / span > < span class = "nx" > h< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Implement< / span > < span class = "nx" > parser< / span > < span class = "nx" > and< / span > < span class = "nx" > jison< / span > < span class = "p" > :< / span > < span class = "nx" > crit< / span > < span class = "p" > ,< / span > < span class = "nx" > done< / span > < span class = "p" > ,< / span > < span class = "nx" > after< / span > < span class = "nx" > des1< / span > < span class = "p" > ,< / span > < span class = "mi" > 2< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Create< / span > < span class = "nx" > tests< / span > < span class = "k" > for< / span > < span class = "nx" > parser< / span > < span class = "p" > :< / span > < span class = "nx" > crit< / span > < span class = "p" > ,< / span > < span class = "nx" > active< / span > < span class = "p" > ,< / span > < span class = "mi" > 3< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Future< / span > < span class = "nx" > task< / span > < span class = "nx" > in< / span > < span class = "nx" > critical< / span > < span class = "nx" > line< / span > < span class = "p" > :< / span > < span class = "nx" > crit< / span > < span class = "p" > ,< / span > < span class = "mi" > 5< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Create< / span > < span class = "nx" > tests< / span > < span class = "k" > for< / span > < span class = "nx" > renderer< / span > < span class = "p" > :< / span > < span class = "mi" > 2< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Add< / span > < span class = "nx" > to< / span > < span class = "nx" > Mermaid< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span > < span class = "nx" > d< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-06-05 17:32:37 +00:00
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to Mermaid
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d
section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
Add to Mermaid :1d
< / div >
2023-02-05 10:13:50 +00:00
< h3 id = "pie-chart-without-zoom" > Pie Chart without Zoom< / h3 >
< 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" > mermaid< / span > < span class = "nx" > zoom< / span > < span class = "p" > =< / span > < span class = "s" > " false" < / span > < span class = "p" > > }}< / span >
2022-11-18 23:02:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pie< / span > < span class = "nx" > title< / span > < span class = "nx" > Pets< / span > < span class = "nx" > adopted< / span > < span class = "nx" > by< / span > < span class = "nx" > volunteers< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Dogs" < / span > < span class = "p" > :< / span > < span class = "mi" > 386< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Cats" < / span > < span class = "p" > :< / span > < span class = "mi" > 85< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Rats" < / span > < span class = "p" > :< / span > < span class = "mi" > 15< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-11-17 22:36:34 +00:00
< div class = "mermaid align-center" >
2022-11-18 23:02:20 +00:00
pie title Pets adopted by volunteers
" Dogs" : 386
" Cats" : 85
" Rats" : 15
2022-11-17 22:36:34 +00:00
< / div >
2022-11-18 23:02:20 +00:00
< h3 id = "requirement-diagram" > Requirement Diagram< / h3 >
2022-11-17 22:36:34 +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 = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-11-18 23:02:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > requirementDiagram< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > requirement< / span > < span class = "nx" > test_req< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > id< / span > < span class = "p" > :< / span > < span class = "mi" > 1< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > text< / span > < span class = "p" > :< / span > < span class = "nx" > the< / span > < span class = "nx" > test< / span > < span class = "nx" > text< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > risk< / span > < span class = "p" > :< / span > < span class = "nx" > high< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > verifymethod< / span > < span class = "p" > :< / span > < span class = "nx" > test< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > element< / span > < span class = "nx" > test_entity< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "kd" > type< / span > < span class = "p" > :< / span > < span class = "nx" > simulation< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > test_entity< / span > < span class = "o" > -< / span > < span class = "nx" > satisfies< / span > < span class = "o" > -< / span > < span class = "p" > > < / span > < span class = "nx" > test_req< / span >
2022-11-17 22:36:34 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-10-31 14:31:20 +00:00
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
requirementDiagram
requirement test_req {
id: 1
text: the test text.
risk: high
verifymethod: test
}
element test_entity {
type: simulation
}
test_entity - satisfies -> test_req
2022-11-17 22:36:34 +00:00
< / div >
< h3 id = "git-graph" > Git Graph< / h3 >
< 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" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > gitGraph< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > branch< / span > < span class = "nx" > develop< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > checkout< / span > < span class = "nx" > develop< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > checkout< / span > < span class = "nx" > main< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > merge< / span > < span class = "nx" > develop< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > commit< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-17 22:36:34 +00:00
gitGraph
commit
commit
branch develop
checkout develop
commit
commit
checkout main
merge develop
commit
commit
< / div >
2022-11-18 23:02:20 +00:00
< h3 id = "c4-diagrams" > C4 Diagrams< / h3 >
2022-11-17 22:36:34 +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 = "p" > {{< < / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
2022-11-18 23:02:20 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > C4Context< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "nx" > System< / span > < span class = "nx" > Context< / span > < span class = "nx" > diagram< / span > < span class = "k" > for< / span > < span class = "nx" > Internet< / span > < span class = "nx" > Banking< / span > < span class = "nx" > System< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Enterprise_Boundary< / span > < span class = "p" > (< / span > < span class = "nx" > b0< / span > < span class = "p" > ,< / span > < span class = "s" > " BankBoundary0" < / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Person< / span > < span class = "p" > (< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "s" > " Banking Customer A" < / span > < span class = "p" > ,< / span > < span class = "s" > " A customer of the bank, with personal bank accounts." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Person< / span > < span class = "p" > (< / span > < span class = "nx" > customerB< / span > < span class = "p" > ,< / span > < span class = "s" > " Banking Customer B" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Person_Ext< / span > < span class = "p" > (< / span > < span class = "nx" > customerC< / span > < span class = "p" > ,< / span > < span class = "s" > " Banking Customer C" < / span > < span class = "p" > ,< / span > < span class = "s" > " desc" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Person< / span > < span class = "p" > (< / span > < span class = "nx" > customerD< / span > < span class = "p" > ,< / span > < span class = "s" > " Banking Customer D" < / span > < span class = "p" > ,< / span > < span class = "s" > " A customer of the bank, < br/> with personal bank accounts." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "s" > " Internet Banking System" < / span > < span class = "p" > ,< / span > < span class = "s" > " Allows customers to view information about their bank accounts, and make payments." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Enterprise_Boundary< / span > < span class = "p" > (< / span > < span class = "nx" > b1< / span > < span class = "p" > ,< / span > < span class = "s" > " BankBoundary" < / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > SystemDb_Ext< / span > < span class = "p" > (< / span > < span class = "nx" > SystemE< / span > < span class = "p" > ,< / span > < span class = "s" > " Mainframe Banking System" < / span > < span class = "p" > ,< / span > < span class = "s" > " Stores all of the core banking information about customers, accounts, transactions, etc." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System_Boundary< / span > < span class = "p" > (< / span > < span class = "nx" > b2< / span > < span class = "p" > ,< / span > < span class = "s" > " BankBoundary2" < / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System< / span > < span class = "p" > (< / span > < span class = "nx" > SystemA< / span > < span class = "p" > ,< / span > < span class = "s" > " Banking System A" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System< / span > < span class = "p" > (< / span > < span class = "nx" > SystemB< / span > < span class = "p" > ,< / span > < span class = "s" > " Banking System B" < / span > < span class = "p" > ,< / span > < span class = "s" > " A system of the bank, with personal bank accounts. next line." < / 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 > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > System_Ext< / span > < span class = "p" > (< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "s" > " E-mail system" < / span > < span class = "p" > ,< / span > < span class = "s" > " The internal Microsoft Exchange e-mail system." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > SystemDb< / span > < span class = "p" > (< / span > < span class = "nx" > SystemD< / span > < span class = "p" > ,< / span > < span class = "s" > " Banking System D Database" < / span > < span class = "p" > ,< / span > < span class = "s" > " A system of the bank, with personal bank accounts." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Boundary< / span > < span class = "p" > (< / span > < span class = "nx" > b3< / span > < span class = "p" > ,< / span > < span class = "s" > " BankBoundary3" < / span > < span class = "p" > ,< / span > < span class = "s" > " boundary" < / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > SystemQueue< / span > < span class = "p" > (< / span > < span class = "nx" > SystemF< / span > < span class = "p" > ,< / span > < span class = "s" > " Banking System F Queue" < / span > < span class = "p" > ,< / span > < span class = "s" > " A system of the bank." < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > SystemQueue_Ext< / span > < span class = "p" > (< / span > < span class = "nx" > SystemG< / span > < span class = "p" > ,< / span > < span class = "s" > " Banking System G Queue" < / span > < span class = "p" > ,< / span > < span class = "s" > " A system of the bank, with personal bank accounts." < / 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 > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > BiRel< / span > < span class = "p" > (< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "s" > " Uses" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > BiRel< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemE< / span > < span class = "p" > ,< / span > < span class = "s" > " Uses" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Rel< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "s" > " Sends e-mails" < / span > < span class = "p" > ,< / span > < span class = "s" > " SMTP" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > Rel< / span > < span class = "p" > (< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "s" > " Sends e-mails to" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateElementStyle< / span > < span class = "p" > (< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > fontColor< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > bgColor< / span > < span class = "p" > =< / span > < span class = "s" > " grey" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > borderColor< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateRelStyle< / span > < span class = "p" > (< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > textColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > lineColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetX< / span > < span class = "p" > =< / span > < span class = "s" > " 5" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateRelStyle< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemE< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > textColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > lineColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetY< / span > < span class = "p" > =< / span > < span class = "s" > " -10" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateRelStyle< / span > < span class = "p" > (< / span > < span class = "nx" > SystemAA< / span > < span class = "p" > ,< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > textColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > lineColor< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetY< / span > < span class = "p" > =< / span > < span class = "s" > " -40" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetX< / span > < span class = "p" > =< / span > < span class = "s" > " -50" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateRelStyle< / span > < span class = "p" > (< / span > < span class = "nx" > SystemC< / span > < span class = "p" > ,< / span > < span class = "nx" > customerA< / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > textColor< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > lineColor< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetX< / span > < span class = "p" > =< / span > < span class = "s" > " -50" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > offsetY< / span > < span class = "p" > =< / span > < span class = "s" > " 20" < / span > < span class = "p" > )< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nf" > UpdateLayoutConfig< / span > < span class = "p" > (< / span > < span class = "err" > $< / span > < span class = "nx" > c4ShapeInRow< / span > < span class = "p" > =< / span > < span class = "s" > " 3" < / span > < span class = "p" > ,< / span > < span class = "err" > $< / span > < span class = "nx" > c4BoundaryInRow< / span > < span class = "p" > =< / span > < span class = "s" > " 1" < / span > < span class = "p" > )< / span >
2022-11-17 22:36:34 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > mermaid< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-02-05 10:13:50 +00:00
< div class = "mermaid align-center zoom" >
2022-11-18 23:02:20 +00:00
C4Context
title System Context diagram for Internet Banking System
Enterprise_Boundary(b0, " BankBoundary0" ) {
Person(customerA, " Banking Customer A" , " A customer of the bank, with personal bank accounts." )
Person(customerB, " Banking Customer B" )
Person_Ext(customerC, " Banking Customer C" , " desc" )
Person(customerD, " Banking Customer D" , " A customer of the bank, < br/> with personal bank accounts." )
System(SystemAA, " Internet Banking System" , " Allows customers to view information about their bank accounts, and make payments." )
Enterprise_Boundary(b1, " BankBoundary" ) {
SystemDb_Ext(SystemE, " Mainframe Banking System" , " Stores all of the core banking information about customers, accounts, transactions, etc." )
System_Boundary(b2, " BankBoundary2" ) {
System(SystemA, " Banking System A" )
System(SystemB, " Banking System B" , " A system of the bank, with personal bank accounts. next line." )
}
System_Ext(SystemC, " E-mail system" , " The internal Microsoft Exchange e-mail system." )
SystemDb(SystemD, " Banking System D Database" , " A system of the bank, with personal bank accounts." )
Boundary(b3, " BankBoundary3" , " boundary" ) {
SystemQueue(SystemF, " Banking System F Queue" , " A system of the bank." )
SystemQueue_Ext(SystemG, " Banking System G Queue" , " A system of the bank, with personal bank accounts." )
}
}
}
BiRel(customerA, SystemAA, " Uses" )
BiRel(SystemAA, SystemE, " Uses" )
Rel(SystemAA, SystemC, " Sends e-mails" , " SMTP" )
Rel(SystemC, customerA, " Sends e-mails to" )
UpdateElementStyle(customerA, $fontColor=" red" , $bgColor=" grey" , $borderColor=" red" )
UpdateRelStyle(customerA, SystemAA, $textColor=" blue" , $lineColor=" blue" , $offsetX=" 5" )
UpdateRelStyle(SystemAA, SystemE, $textColor=" blue" , $lineColor=" blue" , $offsetY=" -10" )
UpdateRelStyle(SystemAA, SystemC, $textColor=" blue" , $lineColor=" blue" , $offsetY=" -40" , $offsetX=" -50" )
UpdateRelStyle(SystemC, customerA, $textColor=" red" , $lineColor=" red" , $offsetX=" -50" , $offsetY=" 20" )
UpdateLayoutConfig($c4ShapeInRow=" 3" , $c4BoundaryInRow=" 1" )
2022-11-17 22:36:34 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "notice" > Notice< / h1 >
2022-07-05 22:16:52 +00:00
2022-05-28 11:35:09 +00:00
< p > The < code > notice< / code > shortcode shows various types of disclaimers with adjustable color, title and icon to help you structure your page.< / p >
2022-05-23 22:38:50 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle primary" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > There may be pirates< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > It is all about the boxes.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-10-31 14:06:51 +00:00
< p > While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.< / p >
2022-05-23 22:38:50 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-05-23 22:38:50 +00:00
< div class = "tab-nav" >
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-05-23 22:38:50 +00:00
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-05-23 22:38:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-05-23 22:38:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " There may be pirates" < / 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 > < span class = "line" > < span class = "cl" > < span class = "nx" > It< / span > < span class = "nx" > is< / span > < span class = "nx" > all< / span > < span class = "nx" > about< / span > < span class = "nx" > the< / span > < span class = "nx" > boxes< / span > < span class = "p" > .< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-05-23 22:38:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > primary< / span > < span class = "s" > " There may be pirates" < / span > < span class = "s" > " skull-crossbones" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > It< / span > < span class = "nx" > is< / span > < span class = "nx" > all< / span > < span class = "nx" > about< / span > < span class = "nx" > the< / span > < span class = "nx" > boxes< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/notice.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" > " style" < / span > < span class = "s" > " primary" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " title" < / span > < span class = "s" > " There may be pirates" < / 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 = "s" > " content" < / span > < span class = "s" > " It is all about the boxes." < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-05-23 22:38:50 +00:00
< / 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 > style< / strong > < / td >
< td style = "text-align:left" > 1< / td >
< td style = "text-align:left" > < code > default< / code > < / td >
2023-01-23 23:14:54 +00:00
< td style = "text-align:left" > The style scheme used for the box.< br > < br > - by severity: < code > info< / code > , < code > note< / code > , < code > tip< / code > , < code > warning< / code > < br > - by brand color: < code > primary< / code > , < code > secondary< / code > , < code > accent< / code > < br > - by color: < code > blue< / code > , < code > green< / code > , < code > grey< / code > , < code > orange< / code > , < code > red< / code > < br > - by special color: < code > default< / code > , < code > transparent< / code > < / td >
2023-01-23 22:49:15 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > color< / strong > < / td >
< td style = "text-align:left" > < / td >
< td style = "text-align:left" > see notes< / td >
< td style = "text-align:left" > The < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > to be used. If not set, the chosen color depends on the < strong > style< / strong > . Any given value will overwrite the default.< br > < br > - for severity styles: a nice matching color for the severity< br > - for all other styles: the corresponding color< / td >
2022-05-23 22:38:50 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > title< / strong > < / td >
< td style = "text-align:left" > 2< / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > Arbitrary text for the box title. Depending on the < strong > style< / strong > there may be a default title. Any given value will overwrite the default.< br > < br > - for severity styles: the matching title for the severity< br > - for all other styles: < em > < empty> < / em > < br > < br > If you want no title for a severity style, you have to set this parameter to < code > " " < / code > (a non empty string filled with spaces)< / td >
2022-05-23 22:38:50 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < strong > icon< / strong > < / td >
< td style = "text-align:left" > 3< / td >
< td style = "text-align:left" > see notes< / td >
2023-01-23 22:49:15 +00:00
< td style = "text-align:left" > < a href = "../shortcodes/icon/#finding-an-icon" > Font Awesome icon name< / a > set to the left of the title. Depending on the < strong > style< / strong > there may be a default icon. Any given value will overwrite the default.< br > < br > - for severity styles: a nice matching icon for the severity< br > - for all other styles: < em > < empty> < / em > < br > < br > If you want no icon for a severity style, you have to set this parameter to < code > " " < / code > (a non empty string filled with spaces)< / td >
2022-05-23 22:38:50 +00:00
< / tr >
2022-06-22 22:08:50 +00:00
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
2022-10-31 14:06:51 +00:00
< td style = "text-align:left" > Arbitrary text to be displayed in box.< / td >
2022-06-22 22:08:50 +00:00
< / tr >
2022-05-23 22:38:50 +00:00
< / tbody >
< / table >
2022-04-02 13:30:16 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-05-23 22:38:50 +00:00
< h3 id = "by-severity" > By Severity< / h3 >
< h4 id = "info-with-markup" > Info with markup< / h4 >
< 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" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " info" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > An< / span > < span class = "o" > **< / span > < span class = "nx" > information< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-05-23 13:00:05 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > You< / span > < span class = "nx" > can< / span > < span class = "nx" > add< / span > < span class = "nx" > standard< / span > < span class = "nx" > markdown< / span > < span class = "nx" > syntax< / span > < span class = "p" > :< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > multiple< / span > < span class = "nx" > paragraphs< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > bullet< / span > < span class = "nx" > point< / span > < span class = "nx" > lists< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > _emphasized_< / span > < span class = "p" > ,< / span > < span class = "o" > **< / span > < span class = "nx" > bold< / span > < span class = "o" > **< / span > < span class = "nx" > and< / span > < span class = "nx" > even< / span > < span class = "o" > ***< / span > < span class = "nx" > bold< / span > < span class = "nx" > emphasized< / span > < span class = "o" > ***< / span > < span class = "nx" > text< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "p" > [< / span > < span class = "nx" > links< / span > < span class = "p" > ](< / span > < span class = "nx" > https< / span > < span class = "p" > :< / span > < span class = "c1" > //example.com)
2022-05-23 13:00:05 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c1" > < / span > < span class = "o" > -< / span > < span class = "nx" > etc< / span > < span class = "p" > .< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```plaintext
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ...and even source code
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-10-31 14:06:51 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > > < / span > < span class = "nx" > the< / span > < span class = "nx" > possibilities< / span > < span class = "nx" > are< / span > < span class = "nf" > endless< / span > < span class = "p" > (< / span > < span class = "nx" > almost< / span > < span class = "o" > -< / span > < span class = "nx" > including< / span > < span class = "nx" > other< / span > < span class = "nx" > shortcodes< / span > < span class = "nx" > may< / span > < span class = "nx" > or< / span > < span class = "nx" > may< / span > < span class = "nx" > not< / span > < span class = "nx" > work< / span > < span class = "p" > )< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle info" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-info-circle" > < / i > Info< / div >
< div class = "box-content" >
2022-06-07 18:30:50 +00:00
< p > An < strong > information< / strong > disclaimer< / p >
< p > You can add standard markdown syntax:< / p >
< ul >
< li > multiple paragraphs< / li >
< li > bullet point lists< / li >
< li > < em > emphasized< / em > , < strong > bold< / strong > and even < strong > < em > bold emphasized< / em > < / strong > text< / li >
2022-12-23 11:24:54 +00:00
< li > < a href = "https://example.com" target = "_blank" > links< / a > < / li >
2022-06-07 18:30:50 +00:00
< li > etc.< / li >
< / ul >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ...and even source code
< / span > < / span > < / code > < / pre > < / div > < blockquote >
2022-10-31 14:06:51 +00:00
< p > the possibilities are endless (almost - including other shortcodes may or may not work)< / p >
2022-06-07 18:30:50 +00:00
< / blockquote >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "note" > Note< / h4 >
2022-05-23 22:38:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " note" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > notice< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-06-07 18:30:50 +00:00
< p > A < strong > notice< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< h4 id = "tip" > Tip< / h4 >
2022-06-07 18:30:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " tip" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > tip< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle tip" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-lightbulb" > < / i > Tip< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > A < strong > tip< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< h4 id = "warning" > Warning< / h4 >
< 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" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > warning< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-triangle" > < / i > Warning< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > warning< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "warning-with-non-default-title-and-icon" > Warning with Non-Default Title and Icon< / h4 >
2022-05-23 22:38:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Here are dragons" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " dragon" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > warning< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-dragon" > < / i > Here are dragons< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > warning< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "warning-without-a-title-and-icon" > Warning without a Title and Icon< / h4 >
2022-05-23 22:38:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " warning" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " " < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > warning< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle warning" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < / div >
< div class = "box-content" >
2022-06-07 18:30:50 +00:00
< p > A < strong > warning< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
< h3 id = "by-brand-colors" > By Brand Colors< / h3 >
2022-06-05 17:32:37 +00:00
< h4 id = "primary-with-title-only" > Primary with Title only< / h4 >
2022-06-07 18:30:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " primary" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Primary" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > primary< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle primary" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > Primary< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > primary< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "secondary-with-icon-only" > Secondary with Icon only< / h4 >
< 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" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " secondary" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " stopwatch" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > secondary< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle secondary" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-stopwatch" > < / i > < / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > secondary< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2023-01-23 23:14:54 +00:00
< h4 id = "accent" > Accent< / h4 >
< 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" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " accent" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > An< / span > < span class = "o" > **< / span > < span class = "nx" > accent< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle accent" >
< div class = "box-label" > < / div >
< div class = "box-content" >
< p > An < strong > accent< / strong > disclaimer< / p >
< / div >
< / div >
2022-05-23 22:38:50 +00:00
< h3 id = "by-color" > By Color< / h3 >
2022-06-05 17:32:37 +00:00
< h4 id = "blue-without-a-title-and-icon" > Blue without a Title and Icon< / h4 >
2022-06-07 18:30:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " blue" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > blue< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle blue" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > blue< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "green-with-title-only" > Green with Title only< / h4 >
< 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" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " green" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Green" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > green< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle green" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > Green< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > green< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "grey-with-icon-only" > Grey with Icon only< / h4 >
< 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" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " grey" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " bug" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > grey< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle grey" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-bug" > < / i > < / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > grey< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "orange-with-title-and-icon" > Orange with Title and Icon< / h4 >
< 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" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " orange" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Orange" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " bug" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > orange< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle orange" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-bug" > < / i > Orange< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > orange< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
2023-01-14 00:40:32 +00:00
< h4 id = "red-without-a-title-and-icon" > Red without a Title and Icon< / h4 >
2022-06-07 18:30:50 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " red" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > A< / span > < span class = "o" > **< / span > < span class = "nx" > red< / span > < span class = "o" > **< / span > < span class = "nx" > disclaimer< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle red" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > A < strong > red< / strong > disclaimer< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-05-23 22:38:50 +00:00
< / div >
< h3 id = "by-special-color" > By Special Color< / h3 >
2023-01-23 22:49:15 +00:00
< h4 id = "default-with-positional-parameter" > Default with Positional Parameter< / h4 >
< 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" > notice< / span > < span class = "k" > default< / span > < span class = "s" > " Pay Attention to this Note!" < / span > < span class = "s" > " skull-crossbones" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Some< / span > < span class = "nx" > serious< / span > < span class = "nx" > information< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle default" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Pay Attention to this Note!< / div >
< div class = "box-content" >
2022-05-23 22:38:50 +00:00
< p > Some serious information.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-07 18:30:50 +00:00
< h4 id = "transparent-with-title-and-icon" > Transparent with Title and Icon< / h4 >
2023-01-23 22:49:15 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > notice< / span > < span class = "nx" > style< / span > < span class = "p" > =< / span > < span class = "s" > " transparent" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Pay Attention to this Note!" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " skull-crossbones" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-05-23 22:38:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Some< / span > < span class = "nx" > serious< / span > < span class = "nx" > information< / span > < span class = "p" > .< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2022-06-07 18:30:50 +00:00
< div class = "box notices cstyle transparent" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-skull-crossbones" > < / i > Pay Attention to this Note!< / div >
< div class = "box-content" >
2022-06-07 18:30:50 +00:00
< p > Some serious information.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-01-23 22:49:15 +00:00
< h3 id = "with-user-defined-color-and-font-awesome-brand-icon" > With User-Defined Color and Font Awesome Brand Icon< / h3 >
< 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" > notice< / span > < span class = "nx" > color< / span > < span class = "p" > =< / span > < span class = "s" > " fuchsia" < / span > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s" > " Hugo" < / span > < span class = "nx" > icon< / span > < span class = "p" > =< / span > < span class = "s" > " fab fa-hackerrank" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Victor< / span > < span class = "err" > ?< / span > < span class = "nx" > Is< / span > < span class = "nx" > it< / span > < span class = "nx" > you< / span > < span class = "err" > ?< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > notice< / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle default" style = "--VARIABLE-BOX-color: fuchsia;" >
< div class = "box-label" > < i class = "fab fa-hackerrank" > < / i > Hugo< / div >
< div class = "box-content" >
< p > Victor? Is it you?< / p >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "site-param" > Site param< / h1 >
2022-07-05 22:16:52 +00:00
2022-06-05 17:32:37 +00:00
< p > The < code > siteparam< / code > shortcode prints values of site params.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to use positional aswell or call this shortcode from your own partials.< / p >
2022-06-05 17:32:37 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
2022-06-22 22:08:50 +00:00
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode (positional)')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode (positional)< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > siteparam< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " editURL" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode (positional)"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +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 = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > siteparam< / span > < span class = "s" > " editURL" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/siteparam.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" > " name" < / span > < span class = "s" > " editURL" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > )}}< / span >
2022-06-05 17:32:37 +00:00
< / 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 > name< / strong > < / td >
< td style = "text-align:left" > 1< / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > The name of the site param to be displayed.< / td >
< / tr >
< / tbody >
< / table >
2022-04-02 13:30:16 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-06-05 17:32:37 +00:00
< h3 id = "editurl-from-configtoml" > < code > editURL< / code > from < code > config.toml< / code > < / h3 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-go" data-lang = "go" > < span class = "line" > < span class = "cl" > < span class = "s" > `editURL`< / span > < span class = "nx" > value< / span > < span class = "p" > :< / span > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > siteparam< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " editURL" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
2022-12-23 11:24:54 +00:00
< / span > < / span > < / code > < / pre > < / div > < p > < code > editURL< / code > value: < a href = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/" target = "_blank" > https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/< / a > < / p >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "swagger" > Swagger< / h1 >
2022-07-05 22:16:52 +00:00
2023-01-14 00:40:32 +00:00
< p > The < code > swagger< / code > shortcode uses the < a href = "https://mrin9.github.io/RapiDoc" target = "_blank" > RapiDoc< / a > library to display your Swagger / OpenAPI Specifications.< / p >
2022-04-02 13:30:16 +00:00
2022-05-29 21:00:53 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > This only works in modern browsers.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.< / p >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +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 = "p" > {{< < / span > < span class = "nx" > swagger< / span > < span class = "nx" > src< / span > < span class = "p" > =< / span > < span class = "s" > " https://petstore3.swagger.io/api/v3/openapi.json" < / span > < span class = "p" > > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/swagger.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" > " src" < / span > < span class = "s" > " https://petstore3.swagger.io/api/v3/openapi.json" < / 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 >
2022-06-05 17:32:37 +00:00
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / 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 > src< / strong > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > The URL to the OpenAPI Specification file. This can be relative to the URL of your page if it is a leaf or branch bundle.< / td >
< / tr >
< / tbody >
< / table >
2022-10-06 20:51:16 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-10-06 20:51:16 +00:00
< p > If you want to print out (or generate a PDF) from your Swagger documentation, don’ t initiate printing directly from the page because the elements are optimized for interactive usage in a browser.< / p >
2022-12-16 17:42:17 +00:00
< p > Instead, open the < a href = "../basics/configuration/#activate-print-support" > print preview< / a > in your browser and initiate printing from that page. This page is optimized for reading and expands most of the available sections.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-10-06 20:51:16 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "configuration" > Configuration< / h2 >
< p > Swagger is configured with default settings. You can customize Swagger’ s default settings for all of your files thru a JSON object in your < code > config.toml< / code > or override these settings per page thru your pages frontmatter.< / p >
< p > The JSON object of your < code > config.toml< / code > / frontmatter is forwarded into Swagger’ s initialization. At the moment, only the < code > theme< / code > setting is supported.< / p >
< p > The < code > theme< / code > setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in < code > config.toml< / code > or frontmatter.< / p >
2022-06-05 17:32:37 +00:00
< h3 id = "global-configuration-file" > Global Configuration File< / h3 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < 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" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > swaggerInitialize< / span > < span class = "p" > =< / span > < span class = "s2" > " { \" theme\" : \" dark\" }" < / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div > < h2 id = "example" > Example< / h2 >
< h3 id = "using-local-file" > Using Local File< / h3 >
2022-04-02 13:30:16 +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 = "p" > {{< < / span > < span class = "nx" > swagger< / span > < span class = "nx" > src< / span > < span class = "p" > =< / span > < span class = "s" > " petstore.json" < / span > < span class = "p" > > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-04-02 13:30:16 +00:00
< rapi-doc
2022-10-06 13:49:10 +00:00
allow-spec-file-download="false"
allow-server-selection="false"
allow-try="false"
2022-10-06 20:30:40 +00:00
font-size="default"
2022-10-06 13:49:10 +00:00
render-style="read"
2022-04-02 13:30:16 +00:00
default-schema-tab="example"
layout="column"
load-fonts="false"
schema-description-expanded="true"
schema-style="table"
show-header="false"
2022-11-05 23:35:48 +00:00
spec-url="../shortcodes/swagger/petstore.json"
2022-04-02 13:30:16 +00:00
sort-tags="true"
>< / rapi-doc >
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2023-01-14 00:40:32 +00:00
< h1 id = "tabs" > Tabs< / h1 >
2022-07-05 22:16:52 +00:00
2023-01-14 00:40:32 +00:00
< p > The < code > tabs< / code > shortcode displays arbitrary content in unlimited number of tabs.< / p >
< p > This comes in handy eg. for providing code snippets for multiple languages or providing configuration in different formats.< / p >
2022-04-02 13:30:16 +00:00
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-language" >
2022-04-02 13:30:16 +00:00
< div class = "tab-nav" >
< button
data-tab-item="python"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-05-29 21:35:48 +00:00
onclick="switchTab('tabs-example-language','python')"
2023-01-29 16:05:10 +00:00
>
< span > python< / span > < / button >
2022-04-02 13:30:16 +00:00
< button
2022-06-05 17:32:37 +00:00
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-05 17:32:37 +00:00
onclick="switchTab('tabs-example-language','bash')"
2023-01-29 16:05:10 +00:00
>
< span > bash< / span > < / button >
2022-04-02 13:30:16 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="python"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-python" data-lang = "python" > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " Hello World!" < / span > < span class = "p" > )< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-bash" data-lang = "bash" > < span class = "line" > < span class = "cl" > < span class = "nb" > echo< / span > < span class = "s2" > " Hello World!" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "usage" > Usage< / h2 >
2022-06-22 22:08:50 +00:00
< p > While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.< / p >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "shortcode-parameter" >
2022-06-22 22:08:50 +00:00
< div class = "tab-nav" >
< button
data-tab-item="shortcode"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','shortcode')"
2023-01-29 16:05:10 +00:00
>
< span > shortcode< / span > < / button >
2022-06-22 22:08:50 +00:00
< button
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-22 22:08:50 +00:00
onclick="switchTab('shortcode-parameter','partial')"
2023-01-29 16:05:10 +00:00
>
< span > partial< / span > < / button >
2022-06-22 22:08:50 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="shortcode"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +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 = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " python" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```python
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > print(" Hello World!" )
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " bash" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```bash
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > echo " Hello World!"
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tabs< / span > < span class = "p" > > }}< / span >
2022-06-22 22:08:50 +00:00
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="partial"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-22 22:08:50 +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 = "p" > {{< / span > < span class = "nx" > partial< / span > < span class = "s" > " shortcodes/tabs.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" > " tabs" < / span > < span class = "p" > (< / span > < span class = "nf" > slice< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > (< / span > < span class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " name" < / span > < span class = "s" > " python" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "p" > (< / span > < span class = "s" > " ```python\nprint(\" Hello World!\" )\n```" < / span > < span class = "p" > |< / span > < span class = "nx" > markdownify< / 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 class = "nx" > dict< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " name" < / span > < span class = "s" > " bash" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " content" < / span > < span class = "p" > (< / span > < span class = "s" > " ```bash\necho \" Hello World!\" \n```" < / span > < span class = "p" > |< / span > < span class = "nx" > markdownify< / 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 > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
< h3 id = "parameter" > Parameter< / h3 >
2022-06-05 17:32:37 +00:00
< table >
< thead >
< tr >
< th style = "text-align:left" > Name< / th >
< th style = "text-align:left" > Default< / th >
< th style = "text-align:left" > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
2022-06-23 11:25:28 +00:00
< td style = "text-align:left" > < strong > groupid< / strong > < / td >
2022-06-05 17:32:37 +00:00
< td style = "text-align:left" > < code > default< / code > < / td >
2022-10-02 22:25:49 +00:00
< td style = "text-align:left" > Arbitrary name of the group the tab view belongs to.< br > < br > Tab views with the same < strong > groupid< / strong > sychronize their selected tab. This sychronization applies to the whole site!< / td >
2022-06-05 17:32:37 +00:00
< / tr >
< tr >
< td style = "text-align:left" > < em > < strong > < content> < / strong > < / em > < / td >
< td style = "text-align:left" > < em > < empty> < / em > < / td >
< td style = "text-align:left" > Arbitrary number of tabs defined with the < code > tab< / code > sub-shortcode.< / td >
< / tr >
< / tbody >
< / table >
2022-04-02 13:30:16 +00:00
2022-06-22 22:08:50 +00:00
< div class = "box notices cstyle note" >
2022-12-01 00:38:08 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
2022-06-23 11:25:28 +00:00
< p > When using tab views with different content sets, make sure to use a common < code > groupid< / code > for equal sets of tabs but distinct < code > groupid< / code > for different sets.< / p >
< p > The tab selection is restored automatically based on the < code > groupid< / code > and if it cannot find a tab item because it came from the < code > 'default'< / code > group on a different page then the first tab is selected instead.< / p >
2022-12-04 09:16:01 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< h2 id = "examples" > Examples< / h2 >
2022-06-23 11:25:28 +00:00
< h3 id = "distinct-groupid" > Distinct < code > groupid< / code > < / h3 >
< 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" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " config" < / span > < span class = "p" > > }}< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " json" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```json
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > {
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Hello" : " World"
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " XML" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```xml
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > < Hello> World< /Hello>
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " properties" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```properties
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > Hello = World
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tabs< / span > < span class = "p" > > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < / code > < / pre > < / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-config" >
2022-04-02 13:30:16 +00:00
< div class = "tab-nav" >
< button
data-tab-item="json"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-05-29 21:35:48 +00:00
onclick="switchTab('tabs-example-config','json')"
2023-01-29 16:05:10 +00:00
>
< span > json< / span > < / button >
2022-04-02 13:30:16 +00:00
< button
data-tab-item="XML"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-05-29 21:35:48 +00:00
onclick="switchTab('tabs-example-config','XML')"
2023-01-29 16:05:10 +00:00
>
< span > XML< / span > < / button >
2022-04-02 13:30:16 +00:00
< button
data-tab-item="properties"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-05-29 21:35:48 +00:00
onclick="switchTab('tabs-example-config','properties')"
2023-01-29 16:05:10 +00:00
>
< span > properties< / span > < / button >
2022-04-02 13:30:16 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="json"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " Hello" < / span > < span class = "p" > :< / span > < span class = "s2" > " World" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="XML"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-xml" data-lang = "xml" > < span class = "line" > < span class = "cl" > < span class = "nt" > < Hello> < / span > World< span class = "nt" > < /Hello> < / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="properties"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-ini" data-lang = "ini" > < span class = "line" > < span class = "cl" > < span class = "na" > Hello< / span > < span class = "o" > =< / span > < span class = "s" > World< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2022-06-23 11:25:28 +00:00
< h3 id = "non-distinct-groupid" > Non-Distinct < code > groupid< / code > < / h3 >
2022-06-05 17:32:37 +00:00
< p > See what happens to this tab view if you select < strong > properties< / strong > tab from the previous example.< / p >
2022-06-23 11:25:28 +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 = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " config" < / span > < span class = "p" > > }}< / span >
2022-06-05 17:32:37 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " json" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```json
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > {
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > " Hello" : " World"
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > }
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " XML" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```xml
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > < Hello> World< /Hello>
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-config" >
2022-06-05 17:32:37 +00:00
< div class = "tab-nav" >
< button
data-tab-item="json"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-06-05 17:32:37 +00:00
onclick="switchTab('tabs-example-config','json')"
2023-01-29 16:05:10 +00:00
>
< span > json< / span > < / button >
2022-06-05 17:32:37 +00:00
< button
data-tab-item="XML"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-06-05 17:32:37 +00:00
onclick="switchTab('tabs-example-config','XML')"
2023-01-29 16:05:10 +00:00
>
< span > XML< / span > < / button >
2022-06-05 17:32:37 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="json"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-json" data-lang = "json" > < span class = "line" > < span class = "cl" > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nt" > " Hello" < / span > < span class = "p" > :< / span > < span class = "s2" > " World" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="XML"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-06-05 17:32:37 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-xml" data-lang = "xml" > < span class = "line" > < span class = "cl" > < span class = "nt" > < Hello> < / span > World< span class = "nt" > < /Hello> < / span >
< / span > < / span > < / code > < / pre > < / div >
2022-11-17 21:58:05 +00:00
< / div >
< / div >
< / div >
< h3 id = "nested-tabs" > Nested Tabs< / h3 >
< p > In case you want to nest tabs, the parent tab that contains the subtabs needs to be declared with < code > {{< tab > }}< / code > instead of < code > {{% tab %}}< / code > . Note, that in this case it is not possible to put markdown in the parent tab.< / p >
< 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" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " main" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " Text" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Simple< / span > < span class = "nx" > text< / span > < span class = "nx" > is< / span > < span class = "nx" > possible< / span > < span class = "nx" > here< / span > < span class = "o" > ...< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " tabs-example-language" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " python" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Python< / span > < span class = "nx" > is< / span > < span class = "o" > **< / span > < span class = "nx" > super< / span > < span class = "o" > **< / span > < span class = "nx" > easy< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "nx" > most< / span > < span class = "nx" > of< / span > < span class = "nx" > the< / span > < span class = "nx" > time< / span > < span class = "p" > .< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > -< / span > < span class = "k" > if< / span > < span class = "nx" > you< / span > < span class = "nx" > don< / span > < span class = "err" > ' < / span > < span class = "nx" > t< / span > < span class = "nx" > want< / span > < span class = "nx" > to< / span > < span class = "nx" > output< / span > < span class = "nx" > unicode< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " bash" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > Bash< / span > < span class = "nx" > is< / span > < span class = "k" > for< / span > < span class = "o" > **< / span > < span class = "nx" > hackers< / 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 = "o" > /< / span > < span class = "nx" > tab< / 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" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " Code" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "o" > ...< / span > < span class = "nx" > but< / span > < span class = "nx" > no< / span > < span class = "nx" > markdown< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "nx" > tabs< / span > < span class = "nx" > groupid< / span > < span class = "p" > =< / span > < span class = "s" > " tabs-example-language" < / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "nx" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " python" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```python
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > print(" Hello World!" )
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tab< / span > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s" > " bash" < / span > < span class = "o" > %< / span > < span class = "p" > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```bash
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > echo " Hello World!"
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s" > ```< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< / span > < span class = "o" > %< / span > < span class = "o" > /< / span > < span class = "nx" > tab< / 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" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tab< / span > < span class = "p" > > }}< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > {{< < / span > < span class = "o" > /< / span > < span class = "nx" > tabs< / span > < span class = "p" > > }}< / span >
< / span > < / span > < / code > < / pre > < / div >
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "main" >
2022-11-17 21:58:05 +00:00
< div class = "tab-nav" >
< button
data-tab-item="Text"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-11-17 21:58:05 +00:00
onclick="switchTab('main','Text')"
2023-01-29 16:05:10 +00:00
>
< span > Text< / span > < / button >
2022-11-17 21:58:05 +00:00
< button
data-tab-item="Code"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-11-17 21:58:05 +00:00
onclick="switchTab('main','Code')"
2023-01-29 16:05:10 +00:00
>
< span > Code< / span > < / button >
2022-11-17 21:58:05 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="Text"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
Simple text is possible here...
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-language" >
2022-11-17 21:58:05 +00:00
< div class = "tab-nav" >
< button
data-tab-item="python"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-11-17 21:58:05 +00:00
onclick="switchTab('tabs-example-language','python')"
2023-01-29 16:05:10 +00:00
>
< span > python< / span > < / button >
2022-11-17 21:58:05 +00:00
< button
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-11-17 21:58:05 +00:00
onclick="switchTab('tabs-example-language','bash')"
2023-01-29 16:05:10 +00:00
>
< span > bash< / span > < / button >
2022-11-17 21:58:05 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="python"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
< p > Python is < strong > super< / strong > easy.< / p >
< ul >
< li > most of the time.< / li >
< li > if you don’ t want to output unicode< / li >
< / ul >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
< p > Bash is for < strong > hackers< / strong > .< / p >
< / div >
< / div >
< / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="Code"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
...but no markdown
2023-01-29 16:05:10 +00:00
< div class = "tab-panel" data-tab-group = "tabs-example-language" >
2022-11-17 21:58:05 +00:00
< div class = "tab-nav" >
< button
data-tab-item="python"
2023-02-08 21:24:18 +00:00
class="tab-nav-button active"
2022-11-17 21:58:05 +00:00
onclick="switchTab('tabs-example-language','python')"
2023-01-29 16:05:10 +00:00
>
< span > python< / span > < / button >
2022-11-17 21:58:05 +00:00
< button
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-nav-button"
2022-11-17 21:58:05 +00:00
onclick="switchTab('tabs-example-language','bash')"
2023-01-29 16:05:10 +00:00
>
< span > bash< / span > < / button >
2022-11-17 21:58:05 +00:00
< / div >
< div class = "tab-content" >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="python"
2023-02-07 17:07:26 +00:00
class="tab-content-text active"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-python" data-lang = "python" > < span class = "line" > < span class = "cl" > < span class = "nb" > print< / span > < span class = "p" > (< / span > < span class = "s2" > " Hello World!" < / span > < span class = "p" > )< / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
2023-01-29 16:05:10 +00:00
< div
data-tab-item="bash"
2023-02-08 21:24:18 +00:00
class="tab-content-text"
2023-01-29 16:05:10 +00:00
>
2022-11-17 21:58:05 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-bash" data-lang = "bash" > < span class = "line" > < span class = "cl" > < span class = "nb" > echo< / span > < span class = "s2" > " Hello World!" < / span >
< / span > < / span > < / code > < / pre > < / div >
< / div >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-05 17:32:37 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< footer class = "footline" >
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2022-07-17 23:32:02 +00:00
< / section > < / div >
2022-04-02 13:30:16 +00:00
< / main >
< / div >
2023-02-26 11:53:15 +00:00
< script src = "../js/clipboard.min.js?1677412387" defer > < / script >
< script src = "../js/perfect-scrollbar.min.js?1677412387" defer > < / script >
2022-07-02 12:20:53 +00:00
< script >
function useMathJax( config ){
2022-07-17 18:04:59 +00:00
if( !Object.assign ){
return;
}
window.MathJax = Object.assign( window.MathJax || {}, {
2022-07-02 12:20:53 +00:00
loader: {
load: ['[tex]/mhchem']
},
startup: {
elements: [
'.math'
]
},
tex: {
inlineMath: [
['$', '$'],
['\\(', '\\)']
]
},
options: {
enableMenu: false
}
}, config );
}
useMathJax( JSON.parse("{}") );
< / script >
2023-02-26 11:53:15 +00:00
< script id = "MathJax-script" async src = "../js/mathjax/tex-mml-chtml.js?1677412387" > < / script >
< script src = "../js/d3/d3-color.min.js?1677412387" defer > < / script >
< script src = "../js/d3/d3-dispatch.min.js?1677412387" defer > < / script >
< script src = "../js/d3/d3-drag.min.js?1677412387" defer > < / script >
< script src = "../js/d3/d3-ease.min.js?1677412387" defer > < / script >
< script src = "../js/d3/d3-interpolate.min.js?1677412387" defer > < / script >
< script src = "../js/d3/d3-selection.min.js?1677412387" defer > < / script >
< script src = "../js/d3/d3-timer.min.js?1677412387" defer > < / script >
< script src = "../js/d3/d3-transition.min.js?1677412387" defer > < / script >
< script src = "../js/d3/d3-zoom.min.js?1677412387" defer > < / script >
< script src = "../js/mermaid.min.js?1677412387" defer > < / script >
2022-04-02 13:30:16 +00:00
< script >
2022-07-17 18:04:59 +00:00
window.themeUseMermaid = JSON.parse("{ \"securityLevel\": \"loose\" }");
2022-04-02 13:30:16 +00:00
< / script >
2023-02-26 11:53:15 +00:00
< script src = "../js/rapidoc-min.js?1677412387" defer > < / script >
2022-04-02 13:30:16 +00:00
< script >
2022-07-17 18:04:59 +00:00
window.themeUseSwagger = JSON.parse("{}");
2022-04-02 13:30:16 +00:00
< / script >
2023-02-26 11:53:15 +00:00
< script src = "../js/theme.js?1677412387" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
