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-09-26 19:28:12 +00:00
< meta name = "generator" content = "Hugo 0.119.0" >
2023-10-02 09:45:01 +00:00
< meta name = "generator" content = "Relearn 5.22.1+tip" >
2022-04-02 13:30:16 +00:00
< meta name = "description" content = "Documentation for Hugo Relearn Theme" >
2023-10-10 21:22:41 +00:00
< meta name = "author" content = "Sören Weber" >
2023-10-11 16:03:03 +00:00
< meta name = "twitter:card" content = "summary_large_image" >
< meta name = "twitter:image" content = "https://McShelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta name = "twitter:title" content = "Content :: Hugo Relearn Theme" >
< meta name = "twitter:description" content = "Documentation for Hugo Relearn Theme" >
2023-10-11 15:32:39 +00:00
< meta property = "og:title" content = "Content :: Hugo Relearn Theme" >
< meta property = "og:description" content = "Documentation for Hugo Relearn Theme" >
< meta property = "og:type" content = "website" >
2023-10-11 15:42:11 +00:00
< meta property = "og:url" content = "https://McShelby.github.io/hugo-theme-relearn/cont/index.html" >
2023-10-11 15:32:39 +00:00
< meta property = "og:image" content = "https://McShelby.github.io/hugo-theme-relearn/images/hero.png" >
< meta property = "og:site_name" content = "Hugo Relearn Theme" >
2022-04-02 13:30:16 +00:00
< title > Content :: Hugo Relearn Theme< / title >
2023-01-25 11:42:06 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/cont/index.html" rel = "alternate" hreflang = "x-default" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/cont/index.html" rel = "alternate" hreflang = "en" >
< link href = "https://McShelby.github.io/hugo-theme-relearn/pir/cont/index.html" rel = "alternate" hreflang = "pir" >
2022-11-15 06:35:08 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/cont/index.html" rel = "canonical" type = "text/html" title = "Content :: Hugo Relearn Theme" >
2022-11-06 00:38:34 +00:00
< link href = "../cont/index.xml" rel = "alternate" type = "application/rss+xml" title = "Content :: Hugo Relearn Theme" >
2023-10-18 20:12:38 +00:00
< link href = "../images/logo.svg?1697659950" 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-10-18 20:12:38 +00:00
< link href = "../css/fontawesome-all.min.css?1697659951" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../css/fontawesome-all.min.css?1697659951" rel = "stylesheet" > < / noscript >
< link href = "../css/nucleus.css?1697659951" rel = "stylesheet" >
< link href = "../css/auto-complete.css?1697659951" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../css/auto-complete.css?1697659951" rel = "stylesheet" > < / noscript >
< link href = "../css/perfect-scrollbar.min.css?1697659951" rel = "stylesheet" >
< link href = "../css/fonts.css?1697659951" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../css/fonts.css?1697659951" rel = "stylesheet" > < / noscript >
< link href = "../css/theme.css?1697659951" rel = "stylesheet" >
< link href = "../css/theme-auto.css?1697659951" rel = "stylesheet" id = "R-variant-style" >
< link href = "../css/variant.css?1697659951" rel = "stylesheet" >
< link href = "../css/print.css?1697659951" rel = "stylesheet" media = "print" >
< link href = "../css/format-print.css?1697659951" rel = "stylesheet" >
< link href = "../css/ie.css?1697659951" rel = "stylesheet" >
< script src = "../js/url.js?1697659951" > < / script >
< script src = "../js/variant.js?1697659951" > < / 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!';
2023-09-26 20:26:46 +00:00
window.T_Reset_view = 'Reset view';
2023-10-01 10:25:48 +00:00
window.T_View_reset = 'View reset!';
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-08-12 14:11:21 +00:00
window.variants & & variants.init( [ 'auto', 'relearn-bright', 'relearn-light', 'relearn-dark', 'zen-light', 'zen-dark', 'neon', 'learn', 'blue', 'green', 'red' ] );
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:05:54 +00:00
< style >
2023-09-23 08:19:35 +00:00
#R-body img.bg-white {
2022-12-02 15:05:54 +00:00
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 = "../cont/index.html" >
2023-09-23 08:19:35 +00:00
< div id = "R-body" class = "default-animation" >
< div id = "R-body-overlay" > < / div >
< nav id = "R-topbar" >
2023-09-18 18:49:44 +00:00
< div class = "topbar-wrapper" >
2023-09-13 21:30:04 +00:00
< div class = "topbar-sidebar-divider" > < / div >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-start" data-area = "start" >
< div class = "topbar-button topbar-button-sidebar" data-content-empty = "disable" data-width-s = "show" data-width-m = "hide" data-width-l = "hide" >
< button class = "topbar-control" onclick = "toggleNav()" type = "button" title = "Menu (CTRL+ALT+n)" >
2023-09-12 21:10:21 +00:00
< i class = "fa-fw fas fa-bars" > < / i >
< / button >
< / div >
2023-09-13 21:30:04 +00:00
< / div >
2023-09-20 22:28:27 +00:00
< ol class = "topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype = "http://schema.org/BreadcrumbList" > < li
2023-09-23 22:28:49 +00:00
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">< span itemprop = "name" > Content< / span > < meta itemprop = "position" content = "1" > < / li >
2023-09-13 21:30:04 +00:00
< / ol >
2023-09-18 18:49:44 +00:00
< div class = "topbar-area topbar-area-end" data-area = "end" >
2023-09-12 21:19:47 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< / nav >
2023-09-23 08:19:35 +00:00
< div id = "R-main-overlay" > < / div >
< main id = "R-body-inner" class = "highlightable chapter narrow" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
2022-11-07 19:58:08 +00:00
< article class = "chapter" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2022-07-05 22:16:52 +00:00
< div class = "article-subheading" > Chapter 2< / div >
2022-11-13 21:34:47 +00:00
< h1 id = "content" > Content< / h1 >
2022-04-02 13:30:16 +00:00
< p > Find out how to create and organize your content quickly and intuitively.< / p >
< 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 Content< / h1 >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2022-11-13 21:34:47 +00:00
< h1 id = "pages-organization" > Pages organization< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > In < strong > Hugo< / strong > , pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.< / p >
< h2 id = "folders" > Folders< / h2 >
2022-12-23 11:24:54 +00:00
< p > Organize your site like < a href = "https://gohugo.io/content/organization/" target = "_blank" > any other Hugo project< / a > . Typically, you will have a < em > content< / em > folder with all your pages.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > content
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ├── level-one
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── level-two
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ ├── level-three
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ ├── level-four
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ │ ├── _index.md < -- /level-one/level-two/level-three/level-four
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ │ ├── page-4-a.md < -- /level-one/level-two/level-three/level-four/page-4-a
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ │ ├── page-4-b.md < -- /level-one/level-two/level-three/level-four/page-4-b
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ │ └── page-4-c.md < -- /level-one/level-two/level-three/level-four/page-4-c
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ ├── _index.md < -- /level-one/level-two/level-three
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ ├── page-3-a.md < -- /level-one/level-two/level-three/page-3-a
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ ├── page-3-b.md < -- /level-one/level-two/level-three/page-3-b
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ │ └── page-3-c.md < -- /level-one/level-two/level-three/page-3-c
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ ├── _index.md < -- /level-one/level-two
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ ├── page-2-a.md < -- /level-one/level-two/page-2-a
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ ├── page-2-b.md < -- /level-one/level-two/page-2-b
< / span > < / span > < span class = "line" > < span class = "cl" > │ │ └── page-2-c.md < -- /level-one/level-two/page-2-c
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── _index.md < -- /level-one
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── page-1-a.md < -- /level-one/page-1-a
< / span > < / span > < span class = "line" > < span class = "cl" > │ ├── page-1-b.md < -- /level-one/page-1-b
< / span > < / span > < span class = "line" > < span class = "cl" > │ └── page-1-c.md < -- /level-one/page-1-c
< / span > < / span > < span class = "line" > < span class = "cl" > ├── _index.md < -- /
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > └── page-top.md < -- /page-top< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +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" >
2023-06-04 22:25:27 +00:00
2022-04-02 13:30:16 +00:00
< p > < code > _index.md< / code > is required in each folder, it’ < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
< h2 id = "create-your-project" > Create your project< / h2 >
2022-12-23 11:24:54 +00:00
< p > The following steps are here to help you initialize your new website. If you don’ t know Hugo at all, we strongly suggest you to train by following < a href = "https://gohugo.io/overview/quickstart/" target = "_blank" > great documentation for beginners< / a > .< / p >
2022-04-02 13:30:16 +00:00
< p > Hugo provides a < code > new< / code > command to create a new website.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new site < new_project> < / span > < / span > < / code > < / pre > < / div > < p > The Relearn theme provides < a href = "../cont/archetypes/" > archetypes< / a > to help you create this kind of pages.< / p >
2022-07-05 22:16:52 +00:00
< h2 id = "frontmatter-configuration" > Frontmatter Configuration< / h2 >
2022-12-23 11:24:54 +00:00
< p > Each Hugo page has to define a < a href = "https://gohugo.io/content/front-matter/" target = "_blank" > frontmatter< / a > in < em > toml< / em > , < em > yaml< / em > or < em > json< / em > . This site will use < em > toml< / em > in all cases.< / p >
2022-07-05 22:16:52 +00:00
< p > The Relearn theme uses the following parameters on top of Hugo ones:< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Table of contents (toc) is enabled by default. Set this parameter to true to disable it.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Note: Toc is always disabled for chapter pages< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableToc< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set, this will be used for the page' s menu entry (instead of the `title` attribute)< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuTitle< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
2023-09-21 15:25:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set to true, the menu in the sidebar will be displayed in a collapsible tree view. Although the functionality works with old browsers (IE11), the display of the expander icons is limited to modern browsers< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set, this will explicitly override common rules for the expand state of a page' s menu entry< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > alwaysopen< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # If set, this will explicitly override common rules for the sorting order of a page' s submenu entries< / span >
2023-10-12 21:10:25 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > ordersectionsby< / span > < span class = "p" > =< / span > < span class = "s2" > " weight" < / span >
2022-07-03 15:22:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # The title of the page heading will be prefixed by this HTML content< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPre< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # The title of the page heading will be postfixed by this HTML content< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > headingPost< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # The title of the page in menu will be prefixed by this HTML content< / span >
2022-07-03 15:22:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPre< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # The title of the page in menu will be postfixed by this HTML content< / span >
2022-07-03 15:22:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPost< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Hide a menu entry by setting this to true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > hidden< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Display name of this page modifier. If set, it will be displayed in the footer.< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierDisplayName< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > LastModifierEmail< / span > < span class = "p" > =< / span > < span class = "s2" > " " < / span >
2023-08-25 17:35:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # Override default values for image effects, you can even add your own arbitrary effects to the list< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > .< / span > < span class = "nx" > imageEffects< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lightbox< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > shadow< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div > < h3 id = "add-icon-to-a-menu-entry" > Add icon to a menu entry< / h3 >
2022-07-03 15:22:50 +00:00
< p > In the page frontmatter, add a < code > menuPre< / code > param to insert any HTML code before the menu label. The example below uses the GitHub icon.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " GitHub repo" < / span >
2022-07-03 15:22:50 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuPre< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fab fa-github' > < /i> " < / span >
2023-10-18 20:12:38 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div > < p > < a href = "#R-image-4f36263167f1930316f98773e0695ac7" class = "lightbox-link" > < img src = "../cont/pages/frontmatter-icon.png?width=18.75rem" alt = "Title with icon" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 18.75rem;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-4f36263167f1930316f98773e0695ac7" > < img src = "../cont/pages/frontmatter-icon.png?width=18.75rem" alt = "Title with icon" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2022-04-02 13:30:16 +00:00
< h3 id = "ordering-sibling-menupage-entries" > Ordering sibling menu/page entries< / h3 >
2022-12-23 11:24:54 +00:00
< p > Hugo provides a < a href = "https://gohugo.io/content/ordering/" target = "_blank" > flexible way< / a > to handle order for your pages.< / p >
2022-04-02 13:30:16 +00:00
< p > The simplest way is to set < code > weight< / code > parameter to a number.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " My page" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 5< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div > < h3 id = "using-a-custom-title-for-menu-entries" > Using a custom title for menu entries< / h3 >
2022-04-02 13:30:16 +00:00
< p > By default, the Relearn theme will use a page’ s < code > title< / code > attribute for the menu item (or < code > linkTitle< / code > if defined).< / p >
< p > But a page’ s title has to be descriptive on its own while the menu is a hierarchy.
We’ ve added the < code > menuTitle< / code > parameter for that purpose:< / p >
< p > For example (for a page named < code > content/install/linux.md< / code > ):< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Install on Linux" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > menuTitle< / span > < span class = "p" > =< / span > < span class = "s2" > " Linux" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div > < h3 id = "override-expand-state-rules-for-menu-entries" > Override expand state rules for menu entries< / h3 >
2022-04-02 13:30:16 +00:00
< p > You can change how the theme expands menu entries on the side of the content with the < code > alwaysopen< / code > setting on a per page basis. If < code > alwaysopen=false< / code > for any given entry, its children will not be shown in the menu as long as it is not necessary for the sake of navigation.< / p >
< p > The theme generates the menu based on the following rules:< / p >
< ul >
< li > all parent entries of the active page including their siblings are shown regardless of any settings< / li >
< li > immediate children entries of the active page are shown regardless of any settings< / li >
< li > if not overridden, all other first level entries behave like they would have been given < code > alwaysopen=false< / code > < / li >
< li > if not overridden, all other entries of levels besides the first behave like they would have been given < code > alwaysopen=true< / code > < / li >
2022-10-31 14:06:51 +00:00
< li > all visible entries show their immediate children entries if < code > alwaysopen=true< / code > ; this proceeds recursively< / li >
2022-04-02 13:30:16 +00:00
< li > all remaining entries are not shown< / li >
< / ul >
2022-12-16 17:42:17 +00:00
< p > You can see this feature in action on the example page for < a href = "../shortcodes/children/" > children shortcode< / a > and its children pages.< / p >
2023-09-21 15:25:13 +00:00
< h2 id = "disable-section-pages" > Disable Section Pages< / h2 >
< p > You may want to structure your pages in a hierachical way but don’ t want to generate pages for those sections? The theme got you covered.< / p >
< p > To stay with the initial example: Suppose you want < code > level-one< / code > appear in the sidebar but don’ t want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander.< / p >
< p > For this, open < code > content/level-one/_index.md< / code > and add the following frontmatter< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > collapsibleMenu< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < span class = "c" > # this adds the expander to the menu entry if not already set in your config.toml< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > _build< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > render< / span > < span class = "p" > =< / span > < span class = "s2" > " never" < / span > < span class = "c" > # no page will be generated so the page does not have a url< / span > < / span > < / span > < / code > < / pre > < / 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" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2022-11-13 21:34:47 +00:00
< h1 id = "archetypes" > Archetypes< / h1 >
2022-07-05 22:16:52 +00:00
2022-12-23 11:24:54 +00:00
< p > Using the command: < code > hugo new [relative new content path]< / code > , you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: < a href = "https://gohugo.io/content/archetypes/" target = "_blank" > archetypes< / a > . These are preconfigured skeleton pages with default frontmatter.< / p >
2022-07-05 22:16:52 +00:00
< p > The Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.< / p >
< h2 id = "predefined-archetypes" > Predefined Archetypes< / h2 >
< h3 id = "archetypes-home" > Home< / h3 >
< p > A < strong > Home< / strong > page is the starting page of your project. It’ s best to have only one page of this kind in your project.< / p >
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-1a3d7102959d3c6459ff20328f9befea" class = "lightbox-link" > < img src = "../cont/archetypes/pages-home.png?width=60pc" alt = "Home page" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 60pc;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-1a3d7102959d3c6459ff20328f9befea" > < img src = "../cont/archetypes/pages-home.png?width=60pc" alt = "Home page" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2022-07-05 22:16:52 +00:00
< p > To create a home page, run the following command< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind home _index.md< / span > < / span > < / code > < / pre > < / div > < p > This leads to a file with the following content< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > +++
2022-07-05 22:16:52 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > archetype = " home"
< / span > < / span > < span class = "line" > < span class = "cl" > title = " {{ replace .Name " -" " " | title }}"
< / span > < / span > < span class = "line" > < span class = "cl" > +++
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Lorem Ipsum.< / span > < / span > < / code > < / pre > < / div > < h3 id = "archetypes-chapter" > Chapter< / h3 >
2022-07-05 22:16:52 +00:00
< p > A < strong > Chapter< / strong > displays a page meant to be used as introduction for a set of child pages. Commonly, it contains a simple title and a catch line to define content that can be found below it.< / p >
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-1127b9c7bf7e7932a31d3b5e8971d2ac" class = "lightbox-link" > < img src = "../cont/archetypes/pages-chapter.png?width=60pc" alt = "Chapter page" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 60pc;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-1127b9c7bf7e7932a31d3b5e8971d2ac" > < img src = "../cont/archetypes/pages-chapter.png?width=60pc" alt = "Chapter page" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2022-07-05 22:16:52 +00:00
< p > To create a chapter page, run the following command< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind chapter < name> /_index.md< / span > < / span > < / code > < / pre > < / div > < p > This leads to a file with the following content< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > +++
2022-07-05 22:16:52 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > archetype = " chapter"
< / span > < / span > < span class = "line" > < span class = "cl" > title = " {{ replace .Name " -" " " | title }}"
< / span > < / span > < span class = "line" > < span class = "cl" > weight = X
< / span > < / span > < span class = "line" > < span class = "cl" > +++
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Lorem Ipsum.< / span > < / span > < / code > < / pre > < / div > < p > Replace the < code > X< / code > with a number. Because this number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.< / p >
2022-07-05 22:16:52 +00:00
< h3 id = "archetypes-default" > Default< / h3 >
< p > A < strong > Default< / strong > page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.< / p >
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-9811c94b8c0f0b95849de3295fd2aebf" class = "lightbox-link" > < img src = "../cont/archetypes/pages-default.png?width=60pc" alt = "Default page" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 60pc;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-9811c94b8c0f0b95849de3295fd2aebf" > < img src = "../cont/archetypes/pages-default.png?width=60pc" alt = "Default page" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2022-07-05 22:16:52 +00:00
< p > To create a default page, run either one of the following commands< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new < chapter> /< name> /_index.md< / span > < / span > < / code > < / pre > < / div > < p > or< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new < chapter> /< name> .md< / span > < / span > < / code > < / pre > < / div > < p > This leads to a file with the following content< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > +++
2022-07-05 22:16:52 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > title = " {{ replace .Name " -" " " | title }}"
< / span > < / span > < span class = "line" > < span class = "cl" > weight = X
< / span > < / span > < span class = "line" > < span class = "cl" > +++
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Lorem Ipsum.< / span > < / span > < / code > < / pre > < / div > < p > Replace the < code > X< / code > with a number or delete the whole < code > weight< / code > parameter entirely.< / p >
2022-10-31 14:06:51 +00:00
< h2 id = "self-defined-archetypes" > Self defined Archetypes< / h2 >
2022-07-05 22:16:52 +00:00
< p > If you are in need of further archetypes you can define your own or even redefine existing ones.< / p >
< h3 id = "template" > Template< / h3 >
< p > Define a template file in your project at < code > archetypes/< kind> .md< / code > and make sure it has at least the frontmatter parameter for that archetype like< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > +++
2022-07-05 22:16:52 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > archetype = " < span class = "p" > < < / span > < span class = "nt" > kind< / span > < span class = "p" > > < / span > "
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > +++< / span > < / span > < / code > < / pre > < / div > < p > Afterwards you can generate new content files of that kind with the following command< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-shell" data-lang = "shell" > < span class = "line" > < span class = "cl" > hugo new --kind < kind> < name> /_index.md< / span > < / span > < / code > < / pre > < / div > < h3 id = "partials" > Partials< / h3 >
2022-07-05 22:16:52 +00:00
< p > To define how your archetypes are rendered, define corresponding partial files in your projects directory < code > layouts/partials/archetypes/< kind> < / code > .< / p >
< p > If you use an unknown archetype in your frontmatter, the < code > default< / code > archetype will be used to generate the page.< / p >
2022-07-14 20:20:11 +00:00
< p > Related to each archetype, several < em > hook< / em > partial files in the form of < code > < hook> .html< / code > can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.< / p >
2022-07-05 22:16:52 +00:00
< p > The following hooks are used:< / p >
< table >
< thead >
< tr >
2023-07-27 15:06:14 +00:00
< th > Name< / th >
< th > Notes< / th >
2022-07-05 22:16:52 +00:00
< / tr >
< / thead >
< tbody >
< tr >
2023-07-27 15:06:14 +00:00
< td > styleclass< / td >
< td > Defines a set of CSS classes to be added to the HTML’ s < code > < main> < / code > element. You can use these classes to define own CSS rules in your < code > custom-header.html< / code > < / td >
2022-07-05 22:16:52 +00:00
< / tr >
< tr >
2023-07-27 15:06:14 +00:00
< td > article< / td >
< td > Defines the HTML how to render your content< / td >
2022-07-05 22:16:52 +00:00
< / tr >
< / tbody >
< / table >
< p > Take a look at the existing archetypes of this theme to get an idea how to utilize it.< / p >
2022-07-14 20:20:11 +00:00
< h4 id = "output-formats" > Output formats< / h4 >
2022-12-23 11:24:54 +00:00
< p > Each hook file can be overridden of a specific < a href = "https://gohugo.io/templates/output-formats/" target = "_blank" > output format< / a > . Eg. if you define a new output format < code > PLAINTEXT< / code > in your < code > config.toml< / code > , you can add a file < code > layouts/partials/archetypes/default.plaintext.html< / code > to change the way how normal content is written for that output format.< / p >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
2023-10-03 20:51:03 +00:00
< div class = " taxonomy-tags term-list cstyle tags" title = "Tags" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
2023-10-03 11:21:35 +00:00
< ul >
< li > < a class = "term-link" href = "../tags/content/index.html" > Content< / a > < / li >
< / ul >
2023-05-19 18:46:07 +00:00
< / div >
< / header >
2022-11-13 21:34:47 +00:00
< h1 id = "markdown-syntax" > Markdown syntax< / h1 >
2022-07-05 22:16:52 +00:00
2022-12-02 15:05:54 +00:00
< p > Let’ s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.< / p >
2022-04-02 13:30:16 +00:00
< p > < strong > Markdown< / strong > is a better way to write < strong > HTML< / strong > , without all the complexities and ugliness that usually accompanies it.< / p >
< p > Some of the key benefits are:< / p >
< ol >
< li > Markdown is simple to learn, with minimal extra characters so it’ s also quicker to write content.< / li >
< li > Less chance of errors when writing in Markdown.< / li >
2022-12-02 15:05:54 +00:00
< li > Produces valid HTML output.< / li >
2022-04-02 13:30:16 +00:00
< li > Keeps the content and the visual display separate, so you cannot mess up the look of your site.< / li >
< li > Write in any text editor or Markdown application you like.< / li >
< li > Markdown is a joy to use!< / li >
< / ol >
< p > John Gruber, the author of Markdown, puts it like this:< / p >
< blockquote >
< p > The overriding design goal for Markdown’ ’ ’ ’
< cite > John Gruber< / cite > < / p >
< / blockquote >
< p > Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:< / p >
2023-06-03 22:20:43 +00:00
2022-12-02 15:05:54 +00:00
< div class = "box notices cstyle tip" >
< div class = "box-label" > < i class = "fa-fw fas fa-lightbulb" > < / i > Tip< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-23 11:24:54 +00:00
< p > < i class = "fa-fw fas fa-bookmark" > < / i > Bookmark this page and the < a href = "https://commonmark.org/help/" target = "_blank" > official Commonmark reference< / a > for easy future reference!< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< h2 id = "paragraphs" > Paragraphs< / h2 >
< p > In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.< / p >
< p > Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< p > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.< / p >
< p > Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "headings" > Headings< / h2 >
2022-12-02 15:05:54 +00:00
< p > A good idea is to structure your content using headings and subheadings. HTML-headings from < code > h1< / code > through < code > h6< / code > are constructed with a < code > #< / code > for each level.< / p >
< p > In Hugo you usually don’ t use < code > h1< / code > as this is generated by your theme and you should only have one such element in a document.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "gh" > # h1 Heading
2022-12-02 15:05:54 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gh" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ## h2 Heading
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ### h3 Heading
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > #### h4 Heading
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ##### h5 Heading
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ###### h6 Heading< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-04-02 13:30:16 +00:00
< h1 id = "h1-heading" > h1 Heading< / h1 >
< h2 id = "h2-heading" > h2 Heading< / h2 >
< h3 id = "h3-heading" > h3 Heading< / h3 >
< h4 id = "h4-heading" > h4 Heading< / h4 >
< h5 id = "h5-heading" > h5 Heading< / h5 >
< h6 id = "h6-heading" > h6 Heading< / h6 >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2023-06-03 22:20:43 +00:00
< h2 id = "horizontal-rules" > Horizontal Rules< / h2 >
2022-12-02 15:05:54 +00:00
< p > To further structure your content you can add horizontal rules. They create a “ thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes < code > ---< / code > .< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > ---
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< p > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.< / p >
2022-04-02 13:30:16 +00:00
< hr >
2022-12-02 15:05:54 +00:00
< p > Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h2 id = "text-markers" > Text Markers< / h2 >
2022-04-02 13:30:16 +00:00
< h3 id = "bold" > Bold< / h3 >
2022-12-02 15:05:54 +00:00
< p > You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks < code > **< / code > .< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > I am rendered with **bold text**< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< p > I am rendered with < strong > bold text< / strong > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "italics" > Italics< / h3 >
< p > You can emphasize a snippet of text with italics by enclosing it with underscores < code > _< / code > .< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > I am rendered with _italicized text_< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< p > I am rendered with < em > italicized text< / em > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "strikethrough" > Strikethrough< / h3 >
2022-12-02 15:21:29 +00:00
< p > In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes < code > ~~< / code > .< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ~~Strike through this text~~< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< p > < del > Strike through this text< / del > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h2 id = "text-substitution" > Text substitution< / h2 >
< p > This Markdown dialect supports an extension to combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Double quotes < span class = "sb" > `" `< / span > and single quotes < span class = "sb" > `' `< / span > of enclosed text are replaced by < span class = "ge" > **< / span > " double curly quotes" ** and < span class = "ge" > **< / span > ' single curly quotes' **.
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Double dashes < span class = "sb" > `--`< / span > and triple dashes < span class = "sb" > `---`< / span > are replaced by en-dash < span class = "ge" > **< / span > --** and em-dash < span class = "ge" > **< / span > ---** entities.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Double arrows pointing left < span class = "sb" > `< < `< / span > or right < span class = "sb" > `> > `< / span > are replaced by arrow < span class = "ge" > **< / span > < span class = "err" > < < < / span > ** and < span class = "ge" > **< / span > > > ** entities.
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Three consecutive dots < span class = "sb" > `...`< / span > are replaced by an ellipsis < span class = "ge" > **< / span > ...** entity.< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< p > Double quotes < code > " < / code > and single quotes < code > '< / code > of enclosed text are replaced by < strong > “ double curly quotes” < / strong > and < strong > ‘ single curly quotes’ < / strong > .< / p >
< p > Double dashes < code > --< / code > and triple dashes < code > ---< / code > are replaced by en-dash < strong > – < / strong > and em-dash < strong > — < / strong > entities.< / p >
< p > Double arrows pointing left < code > < < < / code > or right < code > > > < / code > are replaced by arrow < strong > « < / strong > and < strong > » < / strong > entities.< / p >
< p > Three consecutive dots < code > ...< / code > are replaced by an ellipsis < strong > … < / strong > entity.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "lists" > Lists< / h2 >
< h3 id = "unordered" > Unordered< / h3 >
2022-12-02 15:05:54 +00:00
< p > You can write a list of items in which the order of the items does not explicitly matter.< / p >
< p > It is possible to nest lists by indenting an item for the next sublevel.< / p >
< p > You may use any of < code > -< / code > , < code > *< / code > or < code > +< / code > to denote bullets for each list item but should not switch between those symbols inside one whole list.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Lorem ipsum dolor sit amet
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Consectetur adipiscing elit
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Vestibulum laoreet porttitor sem
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Ac tristique libero volutpat at
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Nulla volutpat aliquam velit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Phasellus iaculis neque
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Purus sodales ultricies
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > - Faucibus porta lacus fringilla vel< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-04-02 13:30:16 +00:00
< ul >
< li > Lorem ipsum dolor sit amet< / li >
2022-12-02 15:05:54 +00:00
< li > Consectetur adipiscing elit
< ul >
< li > Vestibulum laoreet porttitor sem< / li >
< li > Ac tristique libero volutpat at< / li >
< / ul >
< / li >
2022-04-02 13:30:16 +00:00
< li > Nulla volutpat aliquam velit
< ul >
< li > Phasellus iaculis neque< / li >
< li > Purus sodales ultricies< / li >
< / ul >
< / li >
2023-06-03 09:12:46 +00:00
< li > Faucibus porta lacus fringilla vel< / li >
2022-04-02 13:30:16 +00:00
< / ul >
2022-12-02 15:05:54 +00:00
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< h3 id = "ordered" > Ordered< / h3 >
< p > You can create a list of items in which the order of items does explicitly matter.< / p >
< p > It is possible to nest lists by indenting an item for the next sublevel.< / p >
< p > Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Lorem ipsum dolor sit amet
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 3.< / span > Consectetur adipiscing elit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Integer molestie lorem at massa
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 7.< / span > Facilisis in pretium nisl aliquet
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 99.< / span > Nulla volutpat aliquam velit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Faucibus porta lacus fringilla vel
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Aenean sit amet erat nunc
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > 17. Eget porttitor lorem< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-04-02 13:30:16 +00:00
< ol >
< li > Lorem ipsum dolor sit amet< / li >
2022-12-02 15:05:54 +00:00
< li > Consectetur adipiscing elit
< ol >
2022-04-02 13:30:16 +00:00
< li > Integer molestie lorem at massa< / li >
< li > Facilisis in pretium nisl aliquet< / li >
2022-12-02 15:05:54 +00:00
< / ol >
< / li >
< li > Nulla volutpat aliquam velit
< ol >
2022-04-02 13:30:16 +00:00
< li > Faucibus porta lacus fringilla vel< / li >
< li > Aenean sit amet erat nunc< / li >
2022-12-02 15:05:54 +00:00
< / ol >
< / li >
2022-04-02 13:30:16 +00:00
< li > Eget porttitor lorem< / li >
< / ol >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "tasks" > Tasks< / h3 >
2022-12-02 15:21:29 +00:00
< p > In GFM (GitHub Flavored Markdown) you can add task lists resulting in checked or unchecked non-clickable items< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "k" > - [x]< / span > Basic Test
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [ ]< / span > More Tests
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [x]< / span > View
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [x]< / span > Hear
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > - [ ] Smell< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< ul >
< li > < input checked = "" disabled = "" type = "checkbox" > Basic Test< / li >
< li > < input disabled = "" type = "checkbox" > More Tests
< ul >
< li > < input checked = "" disabled = "" type = "checkbox" > View< / li >
< li > < input checked = "" disabled = "" type = "checkbox" > Hear< / li >
< li > < input disabled = "" type = "checkbox" > Smell< / li >
< / ul >
< / li >
< / ul >
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2023-05-04 20:31:35 +00:00
< h3 id = "definitions" > Definitions< / h3 >
< p > This Markdown dialect supports an extension to add definition lists. Definition lists are made of terms and definitions of these terms, much like in a dictionary.< / p >
2022-12-02 15:05:54 +00:00
< p > A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.< / p >
< p > If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Apple
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > : Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
< / span > < / span > < span class = "line" > < span class = "cl" > : An American computer company.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Orange
< / span > < / span > < span class = "line" > < span class = "cl" > : The fruit of an evergreen tree of the genus Citrus.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > You can make juice out of it.
< / span > < / span > < span class = "line" > < span class = "cl" > : A telecommunication company.
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > You can' t make juice out of it.< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< dl >
< dt > Apple< / dt >
< dd > Pomaceous fruit of plants of the genus Malus in the family Rosaceae.< / dd >
< dd > An American computer company.< / dd >
< dt > Orange< / dt >
< dd > The fruit of an evergreen tree of the genus Citrus.
< p > You can make juice out of it.< / p >
< / dd >
< dd > A telecommunication company.
< p > You can’ t make juice out of it.< / p >
< / dd >
< / dl >
2022-04-02 13:30:16 +00:00
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "code" > Code< / h2 >
2022-12-02 15:05:54 +00:00
< h3 id = "inline-code" > Inline Code< / h3 >
< p > Inline snippets of code can be wrapped with backticks < code > `< / code > .< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > In this example, < span class = "sb" > `< div> < /div> `< / span > is marked as code.< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< p > In this example, < code > < div> < /div> < / code > is marked as code.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "indented-code-block" > Indented Code Block< / h3 >
< p > A simple code block can be generated by indenting several lines of code by at least two spaces.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Be impressed by my advanced code:
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > // Some comments
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > line 1 of code
< / span > < / span > < span class = "line" > < span class = "cl" > line 2 of code
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > line 3 of code< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< p > Be impressed by my advanced code:< / p >
2022-04-02 13:30:16 +00:00
< pre > < code > // Some comments
line 1 of code
line 2 of code
line 3 of code
< / code > < / pre >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "fenced-code-block" > Fenced Code Block< / h3 >
< p > If you want to gain more control of your code block you can enclose your code by at least three backticks < code > ```< / code > a so called fence.< / p >
< p > In GFM (GitHub Flavored Markdown) you can also add a language specifier directly after the opening fence, < code > ```js< / code > , and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.< / p >
2023-06-21 23:23:13 +00:00
< p > See < a href = "../shortcodes/highlight/" > Code Highlighting< / a > for additional documentation.< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ```js
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > grunt.initConfig({
< / span > < / span > < span class = "line" > < span class = "cl" > assemble: {
< / span > < / span > < span class = "line" > < span class = "cl" > options: {
< / span > < / span > < span class = "line" > < span class = "cl" > assets: ' docs/assets' ,
< / span > < / span > < span class = "line" > < span class = "cl" > data: ' src/data/*.{json,yml}' ,
< / span > < / span > < span class = "line" > < span class = "cl" > helpers: ' src/custom-helpers.js' ,
< / span > < / span > < span class = "line" > < span class = "cl" > partials: [' src/partials/**/*.{hbs,md}' ]
< / span > < / span > < span class = "line" > < span class = "cl" > },
< / span > < / span > < span class = "line" > < span class = "cl" > pages: {
< / span > < / span > < span class = "line" > < span class = "cl" > options: {
< / span > < / span > < span class = "line" > < span class = "cl" > layout: ' default.hbs'
< / span > < / span > < span class = "line" > < span class = "cl" > },
< / span > < / span > < span class = "line" > < span class = "cl" > files: {
< / span > < / span > < span class = "line" > < span class = "cl" > ' ./' : [' src/templates/pages/index.hbs' ]
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > };
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ```< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-js" data-lang = "js" > < span class = "line" > < span class = "cl" > < span class = "nx" > grunt< / span > < span class = "p" > .< / span > < span class = "nx" > initConfig< / span > < span class = "p" > ({< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > assemble< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > options< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > assets< / span > < span class = "o" > :< / span > < span class = "s1" > ' docs/assets' < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > data< / span > < span class = "o" > :< / span > < span class = "s1" > ' src/data/*.{json,yml}' < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > helpers< / span > < span class = "o" > :< / span > < span class = "s1" > ' src/custom-helpers.js' < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > partials< / span > < span class = "o" > :< / span > < span class = "p" > [< / span > < span class = "s1" > ' src/partials/**/*.{hbs,md}' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pages< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > options< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > layout< / span > < span class = "o" > :< / span > < span class = "s1" > ' default.hbs' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > files< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s1" > ' ./' < / span > < span class = "o" > :< / span > < span class = "p" > [< / span > < span class = "s1" > ' src/templates/pages/index.hbs' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > };< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
2022-12-02 15:05:54 +00:00
< / div >
< h2 id = "tables" > Tables< / h2 >
2022-12-02 15:21:29 +00:00
< p > In GFM (GitHub Flavored Markdown) you can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > | Option | Description |
2023-07-27 15:06:14 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > |--------|-------------|
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > | data | path to data files to supply the data that will be passed into templates. |
< / span > < / span > < span class = "line" > < span class = "cl" > | engine | engine to be used for processing templates. Handlebars is the default. |
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > | ext | extension to be used for dest files. |< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-04-02 13:30:16 +00:00
< table >
< thead >
< tr >
< th > Option< / th >
< th > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > data< / td >
< td > path to data files to supply the data that will be passed into templates.< / td >
< / tr >
< tr >
< td > engine< / td >
< td > engine to be used for processing templates. Handlebars is the default.< / td >
< / tr >
< tr >
< td > ext< / td >
< td > extension to be used for dest files.< / td >
< / tr >
< / tbody >
< / table >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "aligned-columns" > Aligned Columns< / h3 >
< p > Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > | Option | Number | Description |
2023-07-27 15:06:14 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > |-------:|:------:|:------------|
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > | data | 1 | path to data files to supply the data that will be passed into templates. |
< / span > < / span > < span class = "line" > < span class = "cl" > | engine | 2 | engine to be used for processing templates. Handlebars is the default. |
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > | ext | 3 | extension to be used for dest files. |< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< table >
2022-04-02 13:30:16 +00:00
< thead >
< tr >
< th style = "text-align:right" > Option< / th >
2022-12-02 15:05:54 +00:00
< th style = "text-align:center" > Number< / th >
< th style = "text-align:left" > Description< / th >
2022-04-02 13:30:16 +00:00
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:right" > data< / td >
2022-12-02 15:05:54 +00:00
< td style = "text-align:center" > 1< / td >
< td style = "text-align:left" > path to data files to supply the data that will be passed into templates.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
< td style = "text-align:right" > engine< / td >
2022-12-02 15:05:54 +00:00
< td style = "text-align:center" > 2< / td >
< td style = "text-align:left" > engine to be used for processing templates. Handlebars is the default.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
< td style = "text-align:right" > ext< / td >
2022-12-02 15:05:54 +00:00
< td style = "text-align:center" > 3< / td >
< td style = "text-align:left" > extension to be used for dest files.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< / tbody >
< / table >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h2 id = "blockquotes" > Blockquotes< / h2 >
< p > For quoting blocks of content from another source within your document add < code > > < / code > before any text you want to quote.< / p >
< p > Blockquotes can also be nested.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
2022-12-02 15:05:54 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > < / span > < span class = "ge" > > > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
2023-06-21 23:23:13 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > >
< / span > < / span > < span class = "line" > < span class = "cl" > > Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< blockquote >
< p > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.< / p >
< blockquote >
< p > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.< / p >
< / blockquote >
< p > Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.< / p >
< / blockquote >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "links" > Links< / h2 >
2022-12-02 15:05:54 +00:00
< h3 id = "autolink" > Autolink< / h3 >
< p > In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > This is a link to https://example.com.< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-23 11:24:54 +00:00
< p > This is a link to < a href = "https://example.com" target = "_blank" > https://example.com< / a > .< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "basic-link" > Basic Link< / h3 >
< p > You can explicitly define links in case you want to use non-absolute URLs or want to give different text.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > [< span class = "nt" > Assemble< / span > ](< span class = "na" > http://assemble.io< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-23 11:24:54 +00:00
< p > < a href = "http://assemble.io" target = "_blank" > Assemble< / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "link-with-tooltip" > Link with Tooltip< / h3 >
< p > For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > [< span class = "nt" > Upstage< / span > ](< span class = "na" > https://github.com/upstage/ " Visit Upstage!" < / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-23 11:24:54 +00:00
< p > < a href = "https://github.com/upstage/" title = "Visit Upstage!" target = "_blank" > Upstage< / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "link-references" > Link References< / h3 >
< p > Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > [Example][somelinkID]
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > [somelinkID]: https://example.com " Go to example domain" < / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-23 11:24:54 +00:00
< p > < a href = "https://example.com" title = "Go to example domain" target = "_blank" > Example< / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "footnotes" > Footnotes< / h3 >
< p > Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.< / p >
< p > Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.< / p >
< p > Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > That' s some text with a footnote[^1]
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > [^1]: And that' s the footnote.
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > That' s some more text with a footnote.[^someid]
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > [^someid]:
< / span > < / span > < span class = "line" > < span class = "cl" > Anything of interest goes here.
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > Blue light glows blue.< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2022-12-02 15:05:54 +00:00
< p > That’ s some text with a footnote< sup id = "fnref:1" > < a href = "#fn:1" class = "footnote-ref" role = "doc-noteref" > 1< / a > < / sup > < / p >
< p > That’ s some more text with a footnote.< sup id = "fnref:2" > < a href = "#fn:2" class = "footnote-ref" role = "doc-noteref" > 2< / a > < / sup > < / p >
2023-06-03 22:20:43 +00:00
< div class = "footnotes" role = "doc-endnotes" >
< hr >
< ol >
< li id = "fn:1" >
< p > And that’ s the footnote.  < a href = "#fnref:1" class = "footnote-backref" role = "doc-backlink" > ↩ ︎ < / a > < / p >
< / li >
< li id = "fn:2" >
< p > Anything of interest goes here.< / p >
< p > Blue light glows blue.  < a href = "#fnref:2" class = "footnote-backref" role = "doc-backlink" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2022-10-08 19:39:32 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "images" > Images< / h2 >
2022-12-02 15:05:54 +00:00
< h3 id = "basic-images" > Basic Images< / h3 >
< p > Images have a similar syntax to links but include a preceding exclamation mark.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spock< / span > ](< span class = "na" > https://octodex.github.com/images/spocktocat.png< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-32b3f58e1c38403f3fe0050b14af9586" class = "lightbox-link" > < img src = "https://octodex.github.com/images/spocktocat.png?width=20vw" alt = "Spock" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-32b3f58e1c38403f3fe0050b14af9586" > < img src = "https://octodex.github.com/images/spocktocat.png?width=20vw" alt = "Spock" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "image-with-tooltip" > Image with Tooltip< / h3 >
< p > Like links, images can also be given a tooltip.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Picard< / span > ](< span class = "na" > https://octodex.github.com/images/jean-luc-picat.jpg " Jean Luc Picard" < / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-24436bc24cac79900d0b25cf5c4dcf33" class = "lightbox-link" > < img src = "https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt = "Picard" title = "Jean Luc Picard" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-24436bc24cac79900d0b25cf5c4dcf33" > < img src = "https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt = "Picard" title = "Jean Luc Picard" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h3 id = "image-references" > Image References< / h3 >
< p > Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![La Forge][laforge]
2022-10-08 19:39:32 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > [laforge]: https://octodex.github.com/images/trekkie.jpg " Geordi La Forge" < / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-47a76fafb0910c8c3524e8cbbd6d1adc" class = "lightbox-link" > < img src = "https://octodex.github.com/images/trekkie.jpg?width=20vw" alt = "La Forge" title = "Geordi La Forge" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-47a76fafb0910c8c3524e8cbbd6d1adc" > < img src = "https://octodex.github.com/images/trekkie.jpg?width=20vw" alt = "La Forge" title = "Geordi La Forge" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2023-08-25 17:35:54 +00:00
< h3 id = "image-effects" > Image Effects< / h3 >
< p > This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default < a href = "../cont/imageeffects/" > behavior is configurable< / a > thru your < code > config.toml< / code > or frontmatter parameter.< / p >
2022-12-02 15:05:54 +00:00
< h4 id = "resizing" > Resizing< / h4 >
< p > Add query parameter < code > width< / code > and/or < code > height< / code > to the link image to resize the image. Values are CSS values (default is < code > auto< / code > ).< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?width=20vw< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-bd2eb1240a98bee1553b334172c97952" class = "lightbox-link" > < img src = "https://octodex.github.com/images/minion.png?width=20vw" alt = "Minion" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-bd2eb1240a98bee1553b334172c97952" > < img src = "https://octodex.github.com/images/minion.png?width=20vw" alt = "Minion" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?height=50px< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-e110ddb7e123e345353bf975bac724c4" class = "lightbox-link" > < img src = "https://octodex.github.com/images/minion.png?height=50px" alt = "Minion" class = "figure-image bg-white border lightbox noshadow" style = "height: 50px; width: auto;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-e110ddb7e123e345353bf975bac724c4" > < img src = "https://octodex.github.com/images/minion.png?height=50px" alt = "Minion" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?height=50px& width=40vw< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-878c333e5b92698124d5a4a5fc787146" class = "lightbox-link" > < img src = "https://octodex.github.com/images/minion.png?height=50px&width=40vw" alt = "Minion" class = "figure-image bg-white border lightbox noshadow" style = "height: 50px; width: 40vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-878c333e5b92698124d5a4a5fc787146" > < img src = "https://octodex.github.com/images/minion.png?height=50px&width=40vw" alt = "Minion" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h4 id = "css-classes" > CSS Classes< / h4 >
< p > Add a query parameter < code > classes< / code > to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.< / p >
< h5 id = "shadow" > Shadow< / h5 >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spidertocat< / span > ](< span class = "na" > https://octodex.github.com/images/spidertocat.png?classes=shadow< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-e155e884f87cee4b04d8bccdea35fc6c" class = "lightbox-link" > < img src = "https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" alt = "Spidertocat" class = "figure-image bg-white border lightbox noborder shadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-e155e884f87cee4b04d8bccdea35fc6c" > < img src = "https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,noborder" alt = "Spidertocat" class = "lightbox-image bg-white border lightbox noborder shadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h5 id = "border" > Border< / h5 >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > DrOctocat< / span > ](< span class = "na" > https://octodex.github.com/images/droctocat.png?classes=border< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-2f0fcd5c267752204a2de8df2af0d33e" class = "lightbox-link" > < img src = "https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" alt = "DrOctocat" class = "figure-image bg-white border lightbox noshadow noshadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-2f0fcd5c267752204a2de8df2af0d33e" > < img src = "https://octodex.github.com/images/droctocat.png?width=20vw&classes=border,noshadow" alt = "DrOctocat" class = "lightbox-image bg-white border lightbox noshadow noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h5 id = "left" > Left< / h5 >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Supertocat< / span > ](< span class = "na" > https://octodex.github.com/images/okal-eltocat.jpg?classes=left< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-6249365b28f90fd94093d466f8d62f71" class = "lightbox-link" > < img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt = "Supertocat" class = "figure-image bg-white border left lightbox noshadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-6249365b28f90fd94093d466f8d62f71" > < img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt = "Supertocat" class = "lightbox-image bg-white border left lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h5 id = "right" > Right< / h5 >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Riddlocat< / span > ](< span class = "na" > https://octodex.github.com/images/riddlocat.jpg?classes=right< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-a27f288b1f7daea27ef5ed8992ccf296" class = "lightbox-link" > < img src = "https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt = "Riddlocat" class = "figure-image bg-white border lightbox right noshadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-a27f288b1f7daea27ef5ed8992ccf296" > < img src = "https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt = "Riddlocat" class = "lightbox-image bg-white border lightbox right noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
< h5 id = "inline" > Inline< / h5 >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spidertocat< / span > ](< span class = "na" > https://octodex.github.com/images/spidertocat.png?classes=inline< / span > )
2022-10-08 19:39:32 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ![< span class = "nt" > DrOctocat< / span > ](< span class = "na" > https://octodex.github.com/images/droctocat.png?classes=inline< / span > )
< / span > < / span > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Supertocat< / span > ](< span class = "na" > https://octodex.github.com/images/okal-eltocat.jpg?classes=inline< / span > )
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Riddlocat< / span > ](< span class = "na" > https://octodex.github.com/images/riddlocat.jpg?classes=inline< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-08f70304099712dfba0feb682f773e16" class = "lightbox-link" > < img src = "https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" alt = "Spidertocat" class = "figure-image bg-white border inline lightbox noshadow" style = "height: auto; width: 10vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-08f70304099712dfba0feb682f773e16" > < img src = "https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline" alt = "Spidertocat" class = "lightbox-image bg-white border inline lightbox noshadow" loading = "lazy" > < / a >
< a href = "#R-image-13b80a0fb4093157a9c64029ac0b8e55" class = "lightbox-link" > < img src = "https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt = "DrOctocat" class = "figure-image bg-white border inline lightbox noshadow" style = "height: auto; width: 10vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-13b80a0fb4093157a9c64029ac0b8e55" > < img src = "https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt = "DrOctocat" class = "lightbox-image bg-white border inline lightbox noshadow" loading = "lazy" > < / a >
< a href = "#R-image-458ca591d8627b7a76f015388f51f6b7" class = "lightbox-link" > < img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt = "Supertocat" class = "figure-image bg-white border inline lightbox noshadow" style = "height: auto; width: 10vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-458ca591d8627b7a76f015388f51f6b7" > < img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt = "Supertocat" class = "lightbox-image bg-white border inline lightbox noshadow" loading = "lazy" > < / a >
< a href = "#R-image-f8b459770593c7029a847ac4841b9e08" class = "lightbox-link" > < img src = "https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt = "Riddlocat" class = "figure-image bg-white border inline lightbox noshadow" style = "height: auto; width: 10vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-f8b459770593c7029a847ac4841b9e08" > < img src = "https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt = "Riddlocat" class = "lightbox-image bg-white border inline lightbox noshadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-11-06 15:27:13 +00:00
< h5 id = "combination" > Combination< / h5 >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > X-tocat< / span > ](< span class = "na" > https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-c5d10abafd2f1814e37816c3b69c9d5e" class = "lightbox-link" > < img src = "https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt = "X-tocat" class = "figure-image bg-white border left lightbox shadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-c5d10abafd2f1814e37816c3b69c9d5e" > < img src = "https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt = "X-tocat" class = "lightbox-image bg-white border left lightbox shadow" loading = "lazy" > < / a > < / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h4 id = "lightbox" > Lightbox< / h4 >
2023-01-29 10:28:20 +00:00
< p > Add the query parameter < code > lightbox=false< / code > to the image link to disable the lightbox.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Homercat< / span > ](< span class = "na" > https://octodex.github.com/images/homercat.png?lightbox=false< / span > )< / span > < / span > < / code > < / pre > < / div >
2023-06-03 22:20:43 +00:00
< div class = "box notices cstyle secondary" >
2022-12-02 15:05:54 +00:00
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2023-06-04 22:25:27 +00:00
2023-08-25 22:01:58 +00:00
< p > < img src = "https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" alt = "Homercat" class = "figure-image bg-white border nolightbox noshadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / p >
< / div >
< / div >
< div class = "box notices cstyle note" >
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
< p > If you want to wrap an image in a link and < code > lightbox=true< / code > is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > [< span class = "nt" > ![Homercat< / span > ](< span class = "na" > https://octodex.github.com/images/homercat.png?lightbox=false< / span > )](https://octodex.github.com/#homercat)< / span > < / span > < / code > < / pre > < / div > < p > < a href = "https://octodex.github.com/#homercat" target = "_blank" > < img src = "https://octodex.github.com/images/homercat.png?width=20vw&lightbox=false" alt = "Homercat" class = "figure-image bg-white border nolightbox noshadow" style = "height: auto; width: 20vw;" loading = "lazy" > < / a > < / p >
2023-08-25 17:35:54 +00:00
< / div >
< / div >
< footer class = "footline" >
< / footer >
< / article >
< article class = "default" >
< header class = "headline" >
< / header >
< h1 id = "image-effects" > Image Effects< / h1 >
< p > The theme supports non-standard < a href = "../cont/markdown/#image-effects" > image effects< / a > .< / p >
< p > As described, you can add this to the URL query parameter, but this may be cumbersome to do it consistently for the whole page.< / p >
< p > Instead, you can configure the defaults in your < code > config.toml< / code > aswell as overriding these default in the pages frontmatter.< / p >
< p > Explicitly set URL query parameter will override the defaults in effect for a page.< / p >
< p > Without any settings in your < code > config.toml< / code > this defaults to< / p >
2023-10-18 20:12:38 +00:00
< div class = "tab-panel" data-tab-group = "4051cba8e86cea54d686f1236cc896a0" >
2023-08-25 17:35:54 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2023-09-05 11:10:04 +00:00
data-tab-item="configtoml"
2023-08-25 17:35:54 +00:00
class="tab-nav-button tab-panel-style cstyle initial active"
2023-10-18 20:12:38 +00:00
onclick="switchTab('4051cba8e86cea54d686f1236cc896a0','configtoml')"
2023-08-25 17:35:54 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > config.toml< / span >
2023-08-25 17:35:54 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2023-09-05 11:10:04 +00:00
data-tab-item="configtoml"
2023-08-25 17:35:54 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "wrap-code 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 = "p" > [< / span > < span class = "nx" > params< / span > < span class = "p" > .< / span > < span class = "nx" > imageEffects< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lightbox< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > shadow< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< / div >
< / div > < p > This can be overridden in a pages frontmatter by eg.< / p >
2023-10-18 20:12:38 +00:00
< div class = "tab-panel" data-tab-group = "cb2f13613a296b32e551ebd272b16c26" >
2023-08-25 17:35:54 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
data-tab-item="frontmatter"
class="tab-nav-button tab-panel-style cstyle initial active"
2023-10-18 20:12:38 +00:00
onclick="switchTab('cb2f13613a296b32e551ebd272b16c26','frontmatter')"
2023-08-25 17:35:54 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > frontmatter< / span >
2023-08-25 17:35:54 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
data-tab-item="frontmatter"
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "wrap-code 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 = "p" > [< / span > < span class = "nx" > imageEffects< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< / div >
< / div > < p > Or by explicitly override settings by URL query parameter< / p >
2023-10-18 20:12:38 +00:00
< div class = "tab-panel" data-tab-group = "5a07d8d1a74454eab6f176f118739f8c" >
2023-08-25 17:35:54 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2023-09-05 11:10:04 +00:00
data-tab-item="url"
2023-08-25 17:35:54 +00:00
class="tab-nav-button tab-panel-style cstyle initial active"
2023-10-18 20:12:38 +00:00
onclick="switchTab('5a07d8d1a74454eab6f176f118739f8c','url')"
2023-08-25 17:35:54 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > URL< / span >
2023-08-25 17:35:54 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2023-09-05 11:10:04 +00:00
data-tab-item="url"
2023-08-25 17:35:54 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?lightbox=false& bg-white=true< / span > )< / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< / div >
< / div > < p > The settings applied to the above image would be< / p >
2023-10-18 20:12:38 +00:00
< div class = "tab-panel" data-tab-group = "e98c15021f31fcca3a56566235990897" >
2023-08-25 17:35:54 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2023-09-05 11:10:04 +00:00
data-tab-item="result"
2023-08-25 17:35:54 +00:00
class="tab-nav-button tab-panel-style cstyle initial active"
2023-10-18 20:12:38 +00:00
onclick="switchTab('e98c15021f31fcca3a56566235990897','result')"
2023-08-25 17:35:54 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > Result< / span >
2023-08-25 17:35:54 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2023-09-05 11:10:04 +00:00
data-tab-item="result"
2023-08-25 17:35:54 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > border< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > lightbox< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > shadow< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > bg-white< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< / div >
< / div > < p > This ends up in the following HTML where the parameter are converted to CSS classes.< / p >
2023-10-18 20:12:38 +00:00
< div class = "tab-panel" data-tab-group = "4bc3427c21d96f124f168943bbdaf49f" >
2023-08-25 17:35:54 +00:00
< div class = "tab-nav" >
< div class = "tab-nav-title" > ​ < / div >
< button
2023-09-05 11:10:04 +00:00
data-tab-item="html"
2023-08-25 17:35:54 +00:00
class="tab-nav-button tab-panel-style cstyle initial active"
2023-10-18 20:12:38 +00:00
onclick="switchTab('4bc3427c21d96f124f168943bbdaf49f','html')"
2023-08-25 17:35:54 +00:00
>
2023-10-01 19:07:53 +00:00
< span class = "tab-nav-text" > HTML< / span >
2023-08-25 17:35:54 +00:00
< / button >
< / div >
< div class = "tab-content-container" >
< div
2023-09-05 11:10:04 +00:00
data-tab-item="html"
2023-08-25 17:35:54 +00:00
class="tab-content tab-panel-style cstyle initial active">
< div class = "tab-content-text" >
< div class = "wrap-code 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" > img< / span > < span class = "na" > src< / span > < span class = "o" > =< / span > < span class = "s" > " https://octodex.github.com/images/minion.png?lightbox=false& bg-white=true" < / span > < span class = "na" > alt< / span > < span class = "o" > =< / span > < span class = "s" > " Minion" < / span > < span class = "na" > class< / span > < span class = "o" > =< / span > < span class = "s" > " bg-white border nolightbox noshadow" < / span > < span class = "p" > > < / span > < / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< / div >
< / div > < h2 id = "extending" > Extending< / h2 >
< p > As you can see in the above example, the < code > bg-white< / code > parameter is not initially supported in the themes default settings. Nevertheless you are free to define arbitrary parameter by just adding them to the URL query parameter or set them in your < code > config.toml< / code > or pages frontmatter.< / p >
< div class = "box notices cstyle note" >
< div class = "box-label" > < i class = "fa-fw fas fa-exclamation-circle" > < / i > Note< / div >
< div class = "box-content" >
< p > If no extended parameter like < code > bg-white< / code > in the example is set on the URL, a < code > class=" nobg-white" < / code > in the HTML will only be generated if a default value was set in the < code > config.toml< / code > or pages frontmatter.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-12-02 15:05:54 +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" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2022-11-13 21:34:47 +00:00
< h1 id = "menu-extra-shortcuts" > Menu extra shortcuts< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > You can define additional menu entries or shortcuts in the navigation menu without any link to content.< / p >
< h2 id = "basic-configuration" > Basic configuration< / h2 >
< p > Edit the website configuration < code > config.toml< / code > and add a < code > [[menu.shortcuts]]< / code > entry for each link your want to add.< / p >
< p > Example from the current website:< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code 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" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fab fa-fw fa-github' > < /i> GitHub repo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " ds" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://github.com/McShelby/hugo-theme-relearn" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 10< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-camera' > < /i> Showcases" < / span >
2023-05-17 22:13:41 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " showcase/" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 11< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bookmark' > < /i> Hugo Documentation" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " hugodoc" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 20< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bullhorn' > < /i> Credits" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " more/credits/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 30< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-tags' > < /i> Tags" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " tags/" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 40< / span > < / span > < / span > < / code > < / pre > < / div > < p > By default, shortcuts are preceded by a title. This title can be disabled by setting < code > disableShortcutsTitle=true< / code > .
2022-10-31 14:06:51 +00:00
However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.< / p >
2022-04-02 13:30:16 +00:00
< p > For example, in your local < code > i18n/en.toml< / code > file, add the following content< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code 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" > Shortcuts-Title< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > other< / span > < span class = "p" > =< / span > < span class = "s2" > " < Your value> " < / span > < / span > < / span > < / code > < / pre > < / div > < p > Read more about < a href = "https://gohugo.io/extras/menus/" target = "_blank" > hugo menu< / a > and < a href = "https://gohugo.io/content-management/multilingual/#translation-of-strings" target = "_blank" > hugo i18n translation strings< / a > < / p >
2022-04-02 13:30:16 +00:00
< h2 id = "i18n" > Configuration for Multilingual mode< / h2 >
< p > When using a multilingual website, you can set different menus for each language. In the < code > config.toml< / code > file, prefix your menu configuration by < code > Languages.< language-id> < / code > .< / p >
< p > Example from the current website:< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code 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" > languages< / span > < span class = "p" > ]< / span >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > ]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Hugo Relearn Theme" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > languageName< / span > < span class = "p" > =< / span > < span class = "s2" > " English" < / span >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageName< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-home' > < /i> Home" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fab fa-fw fa-github' > < /i> GitHub repo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " ds" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://github.com/McShelby/hugo-theme-relearn" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 10< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-camera' > < /i> Showcases" < / span >
2023-06-03 09:12:46 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pageRef< / span > < span class = "p" > =< / span > < span class = "s2" > " showcase/" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 11< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bookmark' > < /i> Hugo Documentation" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " hugodoc" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 20< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bullhorn' > < /i> Credits" < / span >
2023-06-03 09:12:46 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pageRef< / span > < span class = "p" > =< / span > < span class = "s2" > " more/credits/" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 30< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-tags' > < /i> Tags" < / span >
2023-06-03 09:12:46 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pageRef< / span > < span class = "p" > =< / span > < span class = "s2" > " tags/" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 40< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > ]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Cap' n Hugo Relearrrn Theme" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > languageName< / span > < span class = "p" > =< / span > < span class = "s2" > " Arrr! Pirrrates" < / span >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > params< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > landingPageName< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-home' > < /i> Arrr! Home" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fab fa-fw fa-github' > < /i> GitHub repo" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " ds" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://github.com/McShelby/hugo-theme-relearn" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 10< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-camera' > < /i> Showcases" < / span >
2023-06-03 09:12:46 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pageRef< / span > < span class = "p" > =< / span > < span class = "s2" > " showcase/" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 11< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bookmark' > < /i> Cap' n Hugo Documentat' n" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > identifier< / span > < span class = "p" > =< / span > < span class = "s2" > " hugodoc" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " https://gohugo.io/" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 20< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-bullhorn' > < /i> Crrredits" < / span >
2023-06-03 09:12:46 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pageRef< / span > < span class = "p" > =< / span > < span class = "s2" > " more/credits/" < / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 30< / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [[< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > .< / span > < span class = "nx" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-fw fa-tags' > < /i> Arrr! Tags" < / span >
2023-06-03 09:12:46 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pageRef< / span > < span class = "p" > =< / span > < span class = "s2" > " tags/" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 40< / span > < / span > < / span > < / code > < / pre > < / div > < p > Read more about < a href = "https://gohugo.io/extras/menus/" target = "_blank" > hugo menu< / a > and < a href = "https://gohugo.io/content-management/multilingual/#menus" target = "_blank" > hugo multilingual menus< / a > < / p >
2023-05-19 20:34:29 +00:00
< h2 id = "shortcuts-to-pages-inside-of-your-project" > Shortcuts to pages inside of your project< / h2 >
< p > If you have shortcuts to pages inside of your project and you don’ t want them to show up in page menu section, you have two choices:< / p >
< ol >
< li >
2023-09-21 15:25:13 +00:00
< p > Make the page file for the shortcut a < a href = "https://gohugo.io/content-management/age-bundles/#headless-bundle" target = "_blank" > headless branch bundle< / a > (contained in its own subdirectory and called < code > _index.md< / code > ) and add the following frontmatter configuration to the file (see exampleSite’ s < code > content/showcase/_index.en.md< / code > ). This causes its content to < strong > not< / strong > be ontained in the sitemap.< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Showcase" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > _build< / span > < span class = "p" > ]< / span >
2023-05-19 20:34:29 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > render< / span > < span class = "p" > =< / span > < span class = "s2" > " always" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > list< / span > < span class = "p" > =< / span > < span class = "s2" > " never" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > publishResources< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / div > < / li >
2023-09-21 15:25:13 +00:00
< li >
< p > Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he < strong > parent< / strong > (see exampleSite’ s < code > content/more/_index.en.md< / code > ).< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "c" > # title = " More" ### ATTENTION: Don' t give this page a title as this will cause it to be in the breadcrumbs - a thing you most likely don' t want< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > _build< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > render< / span > < span class = "p" > =< / span > < span class = "s2" > " never" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > list< / span > < span class = "p" > =< / span > < span class = "s2" > " never" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > publishResources< / span > < span class = "p" > =< / span > < span class = "kc" > false< / span > < / span > < / span > < / code > < / pre > < / div > < p > In this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’ s < code > content/more/credits.en.md< / code > ). This causes its content to be contained in the sitemap.< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Credits" < / span > < / span > < / span > < / code > < / pre > < / div > < / li >
2023-05-19 20:34:29 +00:00
< / ol >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
< / header >
2022-11-13 21:34:47 +00:00
< h1 id = "multilingual-and-i18n" > Multilingual and i18n< / h1 >
2022-07-05 22:16:52 +00:00
2022-04-02 13:30:16 +00:00
< p > The Relearn theme is fully compatible with Hugo multilingual mode.< / p >
< ul >
2023-10-02 07:58:37 +00:00
< li > Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free to contribute!< / li >
2023-02-09 23:35:46 +00:00
< li > Full support for languages written right to left< / li >
2022-04-02 13:30:16 +00:00
< li > Automatic menu generation from multilingual content< / li >
< li > In-browser language switching< / li >
< / ul >
2023-10-18 20:12:38 +00:00
< p > < a href = "#R-image-950430074a3b7a131ab6771e9ed8691e" class = "lightbox-link" > < img src = "../cont/i18n/i18n-menu.gif?width=18.75rem" alt = "I18n menu" class = "figure-image bg-white border lightbox noshadow" style = "height: auto; width: 18.75rem;" loading = "lazy" > < / a >
< a href = "javascript:history.back();" class = "lightbox-back" id = "R-image-950430074a3b7a131ab6771e9ed8691e" > < img src = "../cont/i18n/i18n-menu.gif?width=18.75rem" alt = "I18n menu" class = "lightbox-image bg-white border lightbox noshadow" loading = "lazy" > < / a > < / p >
2022-04-02 13:30:16 +00:00
< h2 id = "basic-configuration" > Basic configuration< / h2 >
2022-12-23 11:24:54 +00:00
< p > After learning < a href = "https://gohugo.io/content-management/multilingual" target = "_blank" > how Hugo handle multilingual websites< / a > , define your languages in your < code > config.toml< / code > file.< / p >
2022-04-02 13:30:16 +00:00
< p > For example with current English and Piratized English website.< / p >
2023-06-03 22:20:43 +00:00
2023-01-25 11:42:06 +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-06-04 22:25:27 +00:00
2023-05-17 18:59:44 +00:00
< p > Make sure your default language is defined as the first one in the < code > [languages]< / code > array, as the theme needs to make assumptions on it< / p >
2023-06-03 09:12:46 +00:00
< / div >
2023-01-25 11:42:06 +00:00
< / div >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "c" > # English is the default language< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > defaultContentLanguage< / span > < span class = "p" > =< / span > < span class = "s2" > " en" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > languages< / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > en< / span > < span class = "p" > ]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Hugo Relearn Theme" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 1< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > languageName< / span > < span class = "p" > =< / span > < span class = "s2" > " English" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" >
2023-05-17 18:59:44 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > [< / span > < span class = "nx" > languages< / span > < span class = "p" > .< / span > < span class = "nx" > pir< / span > < span class = "p" > ]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Cap' n Hugo Relearrrn Theme" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > weight< / span > < span class = "p" > =< / span > < span class = "mi" > 2< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > languageName< / span > < span class = "p" > =< / span > < span class = "s2" > " Arrr! Pirrrates" < / span > < / span > < / span > < / code > < / pre > < / div > < p > Then, for each new page, append the < em > id< / em > of the language to the file.< / p >
2022-04-02 13:30:16 +00:00
< ul >
< li > Single file < code > my-page.md< / code > is split in two files:
< ul >
< li > in English: < code > my-page.md< / code > < / li >
< li > in Piratized English: < code > my-page.pir.md< / code > < / li >
< / ul >
< / li >
< li > Single file < code > _index.md< / code > is split in two files:
< ul >
< li > in English: < code > _index.md< / code > < / li >
< li > in Piratized English: < code > _index.pir.md< / code > < / li >
< / ul >
< / li >
< / ul >
2023-06-03 22:20:43 +00:00
2022-05-29 21:00:53 +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" >
2023-06-04 22:25:27 +00:00
2022-04-02 13:30:16 +00:00
< p > Be aware that only translated pages are displayed in menu. It’ s not replaced with default language content.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2023-06-03 22:20:43 +00:00
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" >
2023-06-04 22:25:27 +00:00
2022-12-23 11:24:54 +00:00
< p > Use < a href = "https://gohugo.io/content-management/multilingual/#translate-your-content" target = "_blank" > slug< / a > frontmatter parameter to translate urls too.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< / div >
2022-06-12 17:25:16 +00:00
< h2 id = "search" > Search< / h2 >
< p > In case each page’ s content is written in one single language only, the above configuration will already configure the site’ s search functionality correctly.< / p >
2023-06-03 22:20:43 +00:00
2022-06-12 17:25:16 +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" >
2023-06-04 22:25:27 +00:00
2023-01-30 17:00:33 +00:00
< p > Although the theme supports a wide variety of supported languages, the site’ s search via the < a href = "https://lunrjs.com" target = "_blank" > Lunr< / a > search library does not.
2022-06-12 17:25:16 +00:00
You’ ll see error reports in your browsers console log for each unsupported language. Currently unsupported are:< / p >
< ul >
2023-01-30 17:00:33 +00:00
< li > Czech< / li >
2022-06-12 17:25:16 +00:00
< li > Indonesian< / li >
2023-06-03 09:12:46 +00:00
< li > Polish< / li >
2023-10-02 07:58:37 +00:00
< li > Swahili< / li >
2022-06-12 17:25:16 +00:00
< / ul >
< / div >
2023-06-03 09:12:46 +00:00
< / div >
2022-06-12 17:25:16 +00:00
< h3 id = "search-with-mixed-language-support" > Search with mixed language support< / h3 >
2022-10-31 14:06:51 +00:00
< p > In case your page’ s content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your < code > config.toml< / code > to broaden search.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code 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" > additionalContentLanguage< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " en" < / span > < span class = "p" > ]< / span > < / span > < / span > < / code > < / pre > < / div > < p > As this is an array, you can add multiple additional languages.< / p >
2023-06-03 22:20:43 +00:00
2022-06-12 17:25: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" >
2023-06-04 22:25:27 +00:00
2022-10-31 14:06:51 +00:00
< p > Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in < code > zh-CN< / code > , you have to add just < code > zh< / code > to this parameter.< / p >
2023-06-03 09:12:46 +00:00
< / div >
2022-06-12 17:25:16 +00:00
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "overwrite-translation-strings" > Overwrite translation strings< / h2 >
< p > Translations strings are used for common default values used in the theme (< em > Edit< / em > button, < em > Search placeholder< / em > and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.< / p >
< p > To override these values, create a new file in your local i18n folder < code > i18n/< idlanguage> .toml< / code > and inspire yourself from the theme < code > themes/hugo-theme-relearn/i18n/en.toml< / code > < / p >
< h2 id = "disable-language-switching" > Disable language switching< / h2 >
< p > Switching the language in the browser is a great feature, but for some reasons you may want to disable it.< / p >
< p > Just set < code > disableLanguageSwitchingButton=true< / code > in your < code > config.toml< / code > < / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code 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 >
2022-10-31 14:06:51 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "c" > # When using multilingual website, disable the switch language button.< / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > disableLanguageSwitchingButton< / span > < span class = "p" > =< / span > < span class = "kc" > true< / span > < / span > < / span > < / code > < / pre > < / 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" >
2023-05-19 18:46:07 +00:00
< header class = "headline" >
2023-10-03 20:51:03 +00:00
< div class = " taxonomy-tags term-list cstyle tags" title = "Tags" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
2023-10-03 11:21:35 +00:00
< ul >
< li > < a class = "term-link" href = "../tags/tutorial/index.html" > tutorial< / a > < / li >
< / ul >
2023-05-19 18:46:07 +00:00
< / div >
< / header >
2023-05-26 06:40:21 +00:00
< h1 id = "taxonomy" > Taxonomy< / h1 >
2022-07-05 22:16:52 +00:00
2023-05-26 06:40:21 +00:00
< p > The Relearn theme supports Hugo’ s default taxonomies < em > tag< / em > and < em > category< / em > out of the box.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "configuration" > Configuration< / h2 >
2023-05-26 06:40:21 +00:00
< p > Just add tags and/or categories to any page. They can be given as a single string or an array of strings.< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-toml" data-lang = "toml" > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span >
2023-05-26 06:40:21 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > categories< / span > < span class = "p" > =< / span > < span class = "p" > [< / span > < span class = "s2" > " taxonomy" < / span > < span class = "p" > ,< / span > < span class = "s2" > " content" < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > tags< / span > < span class = "p" > =< / span > < span class = "s2" > " tutorial" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > title< / span > < span class = "p" > =< / span > < span class = "s2" > " Taxonomy" < / span >
2023-06-21 23:23:13 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "err" > +++< / span > < / span > < / span > < / code > < / pre > < / div > < h2 id = "behavior" > Behavior< / h2 >
2023-05-26 06:40:21 +00:00
< p > The tags are displayed at the top of the page in alphabetical order.< / p >
< p > The categories are displayed at the bottom of the page in alphabetical order in the default implementation of the theme but can be customized by providing your own < code > content-footer.html< / code > partial.< / p >
< p > Each item is a link to a taxonomy page displaying all the articles with the given term.< / p >
2022-04-02 13:30:16 +00:00
< h2 id = "list-all-the-tags" > List all the tags< / h2 >
2023-05-26 06:40:21 +00:00
< p > In the < code > config.toml< / code > file you can add a shortcut to display all the tags and categories< / p >
2023-06-21 23:23:13 +00:00
< div class = "wrap-code 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" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-tags' > < /i> Tags" < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " /tags" < / span >
2023-05-26 06:40:21 +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" > menu< / span > < span class = "p" > .< / span > < span class = "nx" > shortcuts< / span > < span class = "p" > ]]< / span >
2023-10-05 20:54:46 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > name< / span > < span class = "p" > =< / span > < span class = "s2" > " < i class=' fas fa-layer-group' > < /i> Categories" < / span >
2023-10-03 11:21:35 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > url< / span > < span class = "p" > =< / span > < span class = "s2" > " /categories" < / span > < / span > < / span > < / code > < / pre > < / div > < h2 id = "customization" > Customization< / h2 >
< p > If you define < a href = "https://gohugo.io/content-management/taxonomies/#configure-taxonomies" target = "_blank" > custom taxonomies< / a > and want to display a list of them somewhere on your page (often in the < code > layouts/partials/content-footer.html< / code > ) you can call a partial that does the job for you:< / p >
< div class = "wrap-code highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > {{- partial " term-list.html" (dict
< / span > < / span > < span class = "line" > < span class = "cl" > " page" .
< / span > < / span > < span class = "line" > < span class = "cl" > " taxonomy" " categories"
2023-10-05 06:14:23 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > " icon" " layer-group"
2023-10-03 11:21:35 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > ) }}< / span > < / span > < / code > < / pre > < / div > < h3 id = "parameter" > Parameter< / h3 >
< table >
< thead >
< tr >
< th > Name< / th >
< th > Default< / th >
< th > Notes< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < strong > page< / strong > < / td >
< td > < em > < empty> < / em > < / td >
< td > Mandatory reference to the page.< / td >
< / tr >
< tr >
< td > < strong > taxonomy< / strong > < / td >
< td > < em > < empty> < / em > < / td >
< td > The plural name of the taxonomy to display as used in your frontmatter.< / td >
< / tr >
< tr >
< td > < strong > class< / strong > < / td >
< td > < em > < empty> < / em > < / td >
2023-10-03 20:51:03 +00:00
< td > Additional CSS classes set on the outermost generated HTML element.< br > < br > If set to < code > tags< / code > you will get the visuals for displaying the < em > tags< / em > taxonomy, otherwise it will be a simple list of links as for the < em > categories< / em > taxonomy.< / td >
< / tr >
< tr >
< td > < strong > style< / strong > < / td >
< td > < code > primary< / code > < / td >
< td > The style scheme used if < strong > class< / strong > is < code > tags< / code > .< 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 > , < code > code< / code > < / td >
< / tr >
< tr >
< td > < strong > color< / strong > < / td >
< td > see notes< / td >
< td > The < a href = "https://developer.mozilla.org/en-US/docs/Web/CSS/color_value" target = "_blank" > CSS color value< / a > to be used if < strong > class< / strong > is < code > tags< / code > . 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 >
2023-10-03 11:21:35 +00:00
< / tr >
< tr >
< td > < strong > icon< / strong > < / td >
< td > < em > < empty> < / em > < / td >
< td > An optional < a href = "../shortcodes/icon/#finding-an-icon" > Font Awesome icon name< / a > set to the left of the list.< / td >
< / tr >
< / tbody >
< / table >
2023-05-26 06:40:21 +00:00
2023-10-03 11:21:35 +00:00
< footer class = "footline" >
2023-10-03 20:51:03 +00:00
< div class = " taxonomy-categories term-list cstyle " title = "Categories" style = "--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);" >
2023-10-05 06:14:23 +00:00
< i class = "fa-fw fas fa-layer-group" > < / i >
2023-10-03 11:21:35 +00:00
< ul >
< li > < a class = "term-link" href = "../categories/content/index.html" > content< / a > < / li >
< li > < a class = "term-link" href = "../categories/taxonomy/index.html" > taxonomy< / a > < / li >
< / ul >
< / div >
2022-04-02 13:30:16 +00:00
< / footer >
< / article >
2022-07-05 22:16:52 +00:00
2023-05-17 22:13:41 +00:00
< / section >
< / div >
2022-04-02 13:30:16 +00:00
< / main >
< / div >
2023-10-18 20:12:38 +00:00
< script src = "../js/clipboard.min.js?1697659952" defer > < / script >
< script src = "../js/perfect-scrollbar.min.js?1697659952" defer > < / script >
< script src = "../js/theme.js?1697659952" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
