"content":"Chapter 3 Shortcodes Hugo uses Markdown for its simple content format. However, there are a lot of things that Markdown doesn’t support well. You could use pure HTML to expand possibilities.\nBut this happens to be a bad idea. Everyone uses Markdown because it’s pure and simple to read even non-rendered. You should avoid HTML to keep it as simple as possible.\nTo avoid this limitations, Hugo created shortcodes. A shortcode is a simple snippet inside a page.\nThe Relearn theme provides multiple shortcodes on top of existing ones.\nAttachments List of files attached to a page\nButton Nice buttons on your page\nChildren List the child pages of a page\nExpand Displays an expandable/collapsible section of text on your page\nInclude Displays content from other Markdown files\nMermaid Generation of diagram and flowchart from text in a similar manner as Markdown\nNotice Disclaimers to help you structure your page\nSite param Get value of site params variables in your page\nSwagger Adds UI for your Swagger / OpenAPI Specifications\nTabbed views Synchronize selection of content in different tabbed views\n ",
"content":"In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.\nFolders Organize your site like any other Hugo project. Typically, you will have a content folder with all your pages.\ncontent ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Note _index.md is required in each folder, it’s your “folder home page”\n Types The Relearn theme defines two types of pages. Default and Chapter. Both can be used at any level of the documentation, the only difference being layout display.\nChapter A Chapter 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 under it.\nYou can define any HTML as prefix for the menu. In the example below, it’s just a number but that could be an icon.\n+++ chapter = true pre = \"\u003cb\u003e1. \u003c/b\u003e\" title = \"Basics\" weight = 5 +++ ### Chapter 1 # Basics Discover what this Hugo theme is all about and the core-concepts behind it. To tell the Relearn theme to consider a page as a chapter, set chapter=true in the Front Matter of the page.\nDefault A Default page is any other content page.\n+++ title = \"Installation\" weight = 15 +++ 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 this great documentation for beginners.\nCreate your project Hugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003e The Relearn theme provides archetypes to help you create this kind of pages.\nFront Matter configuration Each Hugo page has to define a Front Matter in toml, yaml or json. This site will use toml in all cases.\nThe Relearn theme uses the following parameters on top of Hugo ones :\n+++ # Table of contents (toc) is enabled by default. Set this parameter to true to disable it. # Note: Toc is always disabled for chapter pages disableToc = false # If set, this will be used for the page's menu entry (instead of the `title` attribute) menuTitle = \"\" # If set, this will explicitly override common rules for the expand state of a page's menu entry alwaysopen = true # If set, this will explicitly override common rules for the sorting order of a page's submenu entries ordersectionsby = \"title\" # The title of the page in menu will be prefixed by this HTML content pre = \"\" # The title of the page in menu will be postfixed by this HTML content post = \"\"#Setthepageasachapter,changingthewayit'sdisplayedchapter=false#Hideamenuentrybysettingthistotruehidden=false#Displaynameofthispagemodifier.Ifset,itwillbedisplayedinthefooter.Las
"content":"Chapter 5 Tests Some pages for internal testing of differnt styles\nCode Some testing for different styles used in syntax highlightning and preformatted blocks\nImages Some testing for different styles of image links\nLinks Some testing for different styles of links\n ",
"content":"Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: archetypes.\nIt is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences.\nChapter To create a Chapter page, run the following commands\nhugo new --kind chapter \u003cname\u003e/_index.md It will create a page with predefined Front-Matter:\n+++ chapter = true pre = \"\u003cb\u003eX. \u003c/b\u003e\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 5 +++ ### Chapter X # Some Chapter title Lorem Ipsum. Default To create a default page, run either one of the following commands either\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.md or\nhugo new \u003cchapter\u003e/\u003cname\u003e.md It will create a page with predefined Front-Matter:\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = 5 +++ Lorem Ipsum. ",
"description":"",
"tags":null,
"title":"Archetypes",
"uri":"/hugo-theme-relearn/cont/archetypes/"
},
{
"content":"This is a demo child page.\nSubpages of this page page 1-1 ",
"content":"Thanks to the simplicity of Hugo, this page is as empty as this theme needs requirements.\nJust download latest version of Hugo binary for your OS (Windows, Linux, Mac) : it’s that simple.\n",
"content":"The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you learn more about it by following this great documentation for beginners.\nCreate your project Hugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003e Install the theme Install the Relearn theme by following this documentation\nThis theme’s repository is: https://github.com/McShelby/hugo-theme-relearn.git\nAlternatively, you can download the theme as .zip file and extract it in the themes directory\nBasic configuration When building the website, you can set a theme by using --theme option. However, we suggest you modify the configuration file (config.toml) and set the theme as the default. You can also add the [outputs] section to enable the search functionality.\n# Change the default theme to be use when building the site with Hugo theme = \"hugo-theme-relearn\" # For search functionality [outputs] home = [ \"HTML\", \"RSS\", \"JSON\"] Create your first chapter page Chapters are pages that contain other child pages. It has a special layout style and usually just contains a chapter name, the title and a brief abstract of the section.\n### Chapter 1 # Basics Discover what this Hugo theme is all about and the core concepts behind it. renders as\nThe Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command\nhugo new --kind chapter basics/_index.md By opening the given file, you should see the property chapter=true on top, meaning this page is a chapter.\nBy default all chapters and pages are created as a draft. If you want to render these pages, remove the property draft: true from the metadata.\nCreate your first content pages Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:\nhugo new basics/first-content.md hugo new basics/second-content/_index.md Feel free to edit those files by adding some sample content and replacing the title value in the beginning of the files.\nLaunching the website locally Launch by using the following command:\nhugo serve Go to http://localhost:1313\nYou should notice three things:\n You have a left-side Basics menu, containing two submenus with names equal to the title properties in the previously created files. The home page explains how to customize it by following the instructions. When you run hugo serve, when the contents of the files change, the page automatically refreshes with the changes. Neat! Build the website When your site is ready to deploy, run the following command:\nhugo A public folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.\n Note This website can be automatically published and hosted with Netlify (Read more about Automated HUGO deployments with Netlify). Alternatively, you can use GitHub pages\n ",
"content":"The Relearn theme uses Hugo’s built-in syntax highlighting for code.\nMarkdown syntax Wrap the code block with three backticks and the name of the language. Highlight will try to auto detect the language if one is not provided.\n```json [ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] ``` Renders to:\n[ { \"title\": \"apples\", \"count\": [12000, 20000], \"description\": {\"text\": \"...\", \"sensitive\": false} }, { \"title\": \"oranges\", \"count\": [17500, null], \"description\": {\"text\": \"...\", \"sensitive\": false} } ] Supported languages Hugo comes with a remarkable list of supported languages.\nRecommended configuration You can choose a color theme from the list of supported themes and add it in your config.toml\n[markup] [markup.highlight] # if set to `guessSyntax = true`, there will be no unstyled code even if no language # was given BUT mermaid code fences will not work anymore! So this is a mandatory # setting for your site guessSyntax = false # choose a color theme or create your own style = \"base16-snazzy\" ",
"content":"Global site parameters On top of Hugo global configuration, the Relearn theme lets you define the following parameters in your config.toml (here, values are default).\nNote that some of these parameters are explained in details in other sections of this documentation.\n[params] # This controls whether submenus will be expanded (true), or collapsed (false) in the # menu; if no setting is given, the first menu level is set to false, all others to true; # this can be overridden in the pages frontmatter alwaysopen = true # Prefix URL to edit current page. Will display an \"Edit\" button on top right hand corner of every page. # Useful to give opportunity to people to create merge request for your doc. # See the config.toml file from this documentation site to have an example. editURL = \"\" # Author of the site, will be used in meta information author = \"\" # Description of the site, will be used in meta information description = \"\" # Shows a checkmark for visited pages on the menu showVisitedLinks = false # Disable search function. It will hide search bar disableSearch = false # Disable search in hidden pages, otherwise they will be shown in search box disableSearchHiddenPages = false # Disables hidden pages from showing up in the sitemap and on Google (et all), otherwise they may be indexed by search engines disableSeoHiddenPages = false # Disables hidden pages from showing up on the tags page although the tag term will be displayed even if all pages are hidden disableTagHiddenPages = false # Javascript and CSS cache are automatically busted when new version of site is generated. # Set this to true to disable this behavior (some proxies don't handle well this optimization) disableAssetsBusting = false # Set this to true to disable copy-to-clipboard button for inline code. disableInlineCopyToClipBoard = false # A title for shortcuts in menu is set by default. Set this to true to disable it. disableShortcutsTitle = false # If set to false, a Home button will appear below the search bar on the menu. # It is redirecting to the landing page of the current language if specified. (Default is \"/\") disableLandingPageButton = true # When using mulitlingual website, disable the switch language button. disableLanguageSwitchingButton = false # Hide breadcrumbs in the header and only show the current page title disableBreadcrumb = true # If set to true, hide table of contents menu in the header of all pages disableToc = false # If set to false, load the Mermaid module on every page regardless if a Mermaid shortcode or Mermaid codefence is present disableMermaid = false # Specifies the remote location of the Mermaid js customMermaidURL = \"https://unpkg.com/mermaid/dist/mermaid.min.js\" # Initialization parameter for Mermaid, see Mermaid documentation mermaidInitialize = \"{ \\\"theme\\\": \\\"default\\\" }\" # If set to false, load the Swagger module on every page regardless if a Swagger shortcode is present disableSwagger = false # Specifies the remote location of the RapiDoc js customSwaggerURL = \"\"https://unpkg.com/rapidoc/dist/rapidoc-min.js\" # Initialization parameter for Swagger, see RapiDoc documentation swaggerInitialize = \"{ \\\"theme\\\": \\\"light\\\" }\" # Hide Next and Previous page buttons normally displayed full height beside content disableNextPrev = true # Order sections in menu by \"weight\" or \"title\". Default to \"weight\"; # this can be overridden in the pages frontmatter ordersectionsby = \"weight\" # Change default color scheme with a variant one. Eg. can be \"red\", \"blue\", \"green\" or an array like [ \"blue\", \"green\" ]. themeVariant = \"relearn-light\" # Change the title separator. Default to \"::\". titleSeparator = \"-\"#Ifsettotrue,themenuinthesidebarwillbedisplayedinacollapsibletreeview.collapsibleMenu=falseAwordonrunningyoursiteinasubfolderThethemerunsbestifyoursiteisinstalledintherootofyourwebserver.Ifyoursiteisservedfromasubfolder,eg.https://example.com/mysite/, you have to set the following lines to your config.toml\
"content":"The Relearn theme has been built to be as configurable as possible by defining multiple partials\nIn themes/hugo-theme-relearn/layouts/partials/, you will find all the partials defined for this theme. If you need to overwrite something, don’t change the code directly. Instead follow this page. You’d create a new partial in the layouts/partials folder of your local project. This partial will have the priority.\nThis theme defines the following partials :\n header.html: the header of the page. Not meant to be overwritten footer.html: the footer of the page.Not meant to be overwritten menu.html: left menu. Not meant to be overwritten search.html: search box. Not meant to be overwritten custom-header.html: custom headers in page. Meant to be overwritten when adding CSS imports. Don’t forget to include style HTML tag directive in your file. custom-footer.html: custom footer in page. Meant to be overwritten when adding Javacript. Don’t forget to include javascript HTML tag directive in your file. favicon.html: the favicon logo.html: the logo, on top left hand corner meta.html: HTML meta tags, if you want to change default behavior menu-pre.html: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page’s pre setting into account. menu-post.html: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page’s post setting into account. menu-footer.html: footer of the the left menu toc.html: table of contents content.html: the content page itself. This can be overridden if you wan’t to display page’s meta data above or below the content. content-footer: footer below the content, has a default implementation but you can overwrite it if you don’t like it. Change the logo Create a new file in layouts/partials/ named logo.html. Then write any HTML you want. You could use an img HTML tag and reference an image created under the static folder, or you could paste a SVG definition!\n Note The size of the logo will adapt automatically\n Change the favicon If your favicon is a SVG, PNG or ICO, just drop off your image in your local static/images/ folder and name it favicon.svg, favicon.png or favicon.ico respectivly.\nIf no favicon file is found, the theme will lookup the alternative filename logo in the same location and will repeat the search for the list of supported file types.\nIf you need to change this default behavior, create a new file in layouts/partials/ named favicon.html. Then write something like this:\n\u003clink rel=\"icon\" href=\"/images/favicon.bmp\" type=\"image/bmp\" /\u003e Change the colors The Relearn theme lets you choose between some predefined color variants in light or dark mode, but feel free to add one yourself!\nYou can preview the shipped variants by changing them in the variant selector at the bottom of the menu.\nSingle variant Set the themeVariant value with the name of your theme file. That’s it!\n[params] themeVariant = \"relearn-light\" In the above exaple your theme file has to be named theme-relearn-light.css\nMultiple variants You can also set multiple variants. In this case, the first variant is the default choosen on first view and a variant switch will be shown in the menu footer.\n[params] # Change default color scheme with a variant one. themeVariant = [ \"relearn-light\", \"relearn-dark\" ] Tip If you want to switch the syntax highlightning theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation according to Hugo’s documentation, and @import this stylesheet in your color variant stylesheet. For an example, take a look into theme-relearn-light.css and config.toml of the exampleSite.\n Roll your own If you are not happy with the shipped variants you can either copy one of the shipped files, edit them in a text editor and configure the themeVariant parameter in your config.toml or just use the interactive variant generator.\n",
"content":"You can define additional menu entries or shortcuts in the navigation menu without any link to content.\nBasic configuration Edit the website configuration config.toml and add a [[menu.shortcuts]] entry for each link your want to add.\nExample from the current website:\n[[menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40 By default, shortcuts are preceded by a title. This title can be disabled by setting disableShortcutsTitle=true. However, if you want to keep the title but change its value, it can be overriden by changing your local i18n translation string configuration.\nFor example, in your local i18n/en.toml file, add the following content\n[Shortcuts-Title] other = \"\u003cYour value\u003e\" Read more about hugo menu and hugo i18n translation strings\nConfiguration for Multilingual mode When using a multilingual website, you can set different menus for each language. In the config.toml file, prefix your menu configuration by Languages.\u003clanguage-id\u003e.\nExample from the current website:\n[Languages] [Languages.en] title = \"Hugo Relearn Theme\" weight = 1 languageName = \"English\" landingPageURL = \"/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Home\" [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Hugo Documentation\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Credits\" url = \"more/credits/\" weight = 30 [[Languages.en.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Tags\" url = \"tags/\" weight = 40 [Languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 1 languageName = \"Arrr! Pirrrates\" landingPageURL = \"/pir/\" landingPageName = \"\u003ci class='fas fa-home'\u003e\u003c/i\u003e Arrr! Home\" [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fab fa-fw fa-github'\u003e\u003c/i\u003e GitHub repo\" identifier = \"ds\" url = \"https://github.com/McShelby/hugo-theme-relearn\" weight = 10 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-camera'\u003e\u003c/i\u003e Showcases\" url = \"more/showcase/\" weight = 11 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bookmark'\u003e\u003c/i\u003e Cap'n Hugo Documentat'n\" identifier = \"hugodoc\" url = \"https://gohugo.io/\" weight = 20 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-bullhorn'\u003e\u003c/i\u003e Crrredits\" url = \"more/credits/\" weight = 30 [[Languages.pir.menu.shortcuts]] name = \"\u003ci class='fas fa-fw fa-tags'\u003e\u003c/i\u003e Arrr! Tags\" url = \"tags/\" weight = 40 Read more about hugo menu and hugo multilingual menus\n",
"content":"This interactive tool may help you to generate your own color variant stylesheet.\nTo get started, first select a color variant from the variant switch that fits you best as a starting point.\nThe graph is interactive and reflect the current colors. You can click on any of the colored boxes to adjust the respective color. The graph and the page will update accordingly.\nThe arrowed lines reflects how colors are inherited thru different parts of the theme if the descendent isn’t overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.\nTo better understand this select the neon variant and modify the differnet heading colors. There, colors for the heading h2, h3 and h4 are explicitly set. h5 is not set and inherits its value from h4. h6 is also not set and inherits its value from h5.\nOnce you’ve changed a color, the variant switch will show a “My custom variant” entry and your changes are stored in the browser. You can change pages and even close the browser without losing your changes.\nOnce you are satisfied, you can download the new variants file and install it in your site.\n Note This only works in modern browsers.\n Variant generator Download color variant Reset variant\nGraph Download color variant Reset variant\n variants.generator( '#vargenerator', '.vardownload', '.varreset' ); ",
"content":"The Relearn theme for Hugo loads the Font Awesome library, allowing you to easily display any icon or logo available in the Font Awesome free collection.\nFinding an icon Browse through the available icons in the Font Awesome Gallery. Notice that the free filter is enabled, as only the free icons are available by default.\nOnce on the Font Awesome page for a specific icon, for example the page for the heart, copy the HTML reference and paste into the Markdown content.\nThe HTML to include the heart icon is:\n\u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e Including in markdown Paste the \u003ci\u003e HTML into markup and Font Awesome will load the relevant icon.\nBuilt with \u003ci class=\"fas fa-heart\"\u003e\u003c/i\u003e by Relearn and Hugo Which appears as\nBuilt with by Relearn and Hugo\nCustomising icons Font Awesome provides many ways to modify the icon\n Change color (by default the icon will inherit the parent color) Increase or decrease size Rotate Combine with other icons Check the full documentation on web fonts with CSS for more.\n",
"content":"The Relearn theme is fully compatible with Hugo multilingual mode.\nIt provides:\n Translation strings for default values (English, Piratized English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese). Feel free to contribute! Automatic menu generation from multilingual content In-browser language switching Basic configuration After learning how Hugo handle multilingual websites, define your languages in your config.toml file.\nFor example with current English and Piratized English website.\n# English is the default language defaultContentLanguage = \"en\" [Languages] [Languages.en] title = \"Hugo Relearn Theme\" weight = 1 languageName = \"English\" [Languages.pir] title = \"Cap'n Hugo Relearrrn Theme\" weight = 2 languageName = \"Arrr! Pirrrates\" Then, for each new page, append the id of the language to the file.\n Single file my-page.md is split in two files: in English: my-page.md in Piratized English: my-page.pir.md Single file _index.md is split in two files: in English: _index.md in Piratized English: _index.pir.md Info Be aware that only translated pages are displayed in menu. It’s not replaced with default language content.\n Tip Use slug Front Matter parameter to translate urls too.\n Overwrite translation strings Translations strings are used for common default values used in the theme (Edit button, Search placeholder and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.\nTo override these values, create a new file in your local i18n folder i18n/\u003cidlanguage\u003e.toml and inspire yourself from the theme themes/hugo-theme-relearn/i18n/en.toml\nDisable language switching Switching the language in the browser is a great feature, but for some reasons you may want to disable it.\nJust set disableLanguageSwitchingButton=true in your config.toml\n[params] # When using mulitlingual website, disable the switch language button. disableLanguageSwitchingButton = true ",
"content":"This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\n",
"content":"The Relearn theme supports one default taxonomy of Hugo: the tag feature.\nConfiguration Just add tags to any page:\n+++ tags = [\"tutorial\", \"theme\"] title = \"Theme tutorial\" weight = 15 +++ Behavior The tags are displayed at the top of the page, in their insertion order.\nEach tag is a link to a Taxonomy page displaying all the articles with the given tag.\nList all the tags In the config.toml file you can add a shortcut to display all the tags\n[[menu.shortcuts]] name = \"\u003ci class='fas fa-tags'\u003e\u003c/i\u003e Tags\" url = \"/tags\" weight = 30 ",
"content":"The attachments shortcode displays a list of files attached to a page with adjustable color, title and icon.\n Attachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) hugo.png (17 KB) hugo.txt (20 B) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Usage The shortcurt lists files found in a specific folder.\n{{% attachments /%}} Currently, it support two implementations for pages\n If your page is a Markdown file, attachements must be placed in a folder named like your page and ending with .files.\n content _index.md page.files attachment.pdf page.md If your page is a folder, attachements must be placed in a nested ‘files’ folder.\n content _index.md page index.md files attachment.pdf Be aware that if you use a multilingual website, you will need to have as many folders as languages.\nParameter Name Optional Default Notes style yes transparent The color scheme used to highlight the box content.- by severity: info, note, tip, warning- by brand color: primary, secondary- by color: blue, green, grey, orange, red- by special color: default, transparent title yes see notes Arbitray text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.- for severity styles: the matching title for the severity- for all other colors: AttachmentsIf you want no title, you have to set this parameter to \" \" (a non empty string filled with spaces) icon yes see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.- for severity styles: a nice matching icon for the severity- for all other colors: paperclipIf you want no icon, you have to set this parameter to \" \" (a non empty string filled with spaces) sort yes asc Sorting the output in ascending or descending order. pattern yes .* A regular expressions, used to filter the attachments by file name. For example:- to match a file suffix of ‘jpg’, use .*jpg (not *.jpg)- to match file names ending in jpg or png, use .*(jpg|png) Examples Custom title, list of attachments ending in pdf or mp4 Related files adivorciarsetoca00cape.pdf (361 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) movieselectricsheep-flock-244-32500-2.mp4 (340 KB) Show markup {{% attachments title=\"Related files\" pattern=\".*(pdf|mp4)\" /%}} Colored styled box, descending sort order Attachments movieselectricsheep-flock-244-32500-2.mp4 (340 KB) hugo.txt (20 B) hugo.png (17 KB) Carroll_AliceAuPaysDesMerveilles.pdf (175 KB) BachGavotteShort.mp3 (357 KB) adivorciarsetoca00cape.pdf (361 KB) Show markup {{% attachments style=\"orange\" sort=\"desc\" /%}} Style and icons For further examples for style, title and icon, see the notice shortcode documentation. The parameter are working the same way for both shortcodes, besides having different defaults.\n",
"content":"A button is a just a clickable button with optional icon.\n{{% button href=\"https://gohugo.io/\" %}}Get Hugo{{% /button %}} {{% button href=\"https://gohugo.io/\" icon=\"fas fa-download\" %}}Get Hugo with icon{{% /button %}} {{% button href=\"https://gohugo.io/\" icon=\"fas fa-download\" icon-position=\"right\" %}}Get Hugo with icon right{{% /button %}} Get Hugo Get Hugo with icon Get Hugo with icon right ",
"content":"Use the children shortcode to list the child pages of a page and the further descendants (children’s children). By default, the shortcode displays links to the child pages.\nUsage Parameter Default Description page current Specify the page name (section name) to display children for containerstyle “ul” Choose the style used to group all children. It could be any HTML tag name style “li” Choose the style used to display each descendant. It could be any HTML tag name showhidden “false” When true, child pages hidden from the menu will be displayed description “false” Allows you to include a short text under each page in the list. When no description exists for the page, children shortcode takes the first 70 words of your content. Read more info about summaries on gohugo.io depth 1 Enter a number to specify the depth of descendants to display. For example, if the value is 2, the shortcode will display 2 levels of child pages. Tips: set 999 to get all descendants sort ordersectionsby Sort children by weight, to sort on menu order - title, to sort alphabetically on menu label. If not set it is sorted by the ordersectionsby setting of the site and the pages frontmatter Demo {{% children %}} page X page 1 page 2 page 3 {{% children description=\"true\" %}} page X This is a plain page test, and the beginning of a YAML multiline description... page 1 This is a demo child page\npage 2 This is a demo child page with no description. So its content is used as description.\npage 3 This is a demo child page\n {{% children depth=\"999\" showhidden=\"true\" %}} page X page 1 page 1-1 page 1-1-1 (hidden) page 1-1-1-1 page 1-1-1-1-1 (hidden) page 1-1-1-1-1-1 page 1-1-2 page 1-1-2-1 page 1-1-2-2 page 1-1-3 page 2 page 3 page 3-1 page 4 (hidden) {{% children containerstyle=\"div\" style=\"h2\" depth=\"3\" description=\"true\" %}} page X This is a plain page test, and the beginning of a YAML multiline description... page 1 This is a demo child page\npage 1-1 This is a demo child page\npage 1-1-2 This is a demo child page\npage 1-1-3 This is a demo child page\npage 2 This is a demo child page with no description. So its content is used as description.\npage 3 This is a demo child page\npage 3-1 This is a plain page test nested in a parent\n {{% children containerstyle=\"div\" style=\"div\" depth=\"999\" %}} page X page 1 page 1-1 page 1-1-2 page 1-1-2-1 page 1-1-2-2 page 1-1-3 page 2 page 3 page 3-1 ",
"content":"Some testing for different styles used in syntax highlightning and preformatted blocks.\nInline Code This is some very long inline code. Where does it wrap?\nWhat about wrapping short inline code if multiple sections are written side by side?\nWhat about wrapping short inline code if multiple sections are written side/by/side?\nWhat about wrapping long inline code if multiple sections are written side567 by34567 side567?\nWhat about wrapping long inline code if multiple sections are written side567/by34567/side567?\nCan we just use a simple HTML element ?\nBlock Code Code fences without any selected language { \"well\": \"some JSON in codefences in here\" } { \"well\": \"some JSON in HTML elements here\" } Block Preformatted Some preformatted stuff with markdown indention Some preformatted stuff in HTML elements ",
"content":"Contributors Special thanks to everyone who has contributed to this project.\nMany thanks to Mathieu Cornic for his work on porting the Learn theme to Hugo.\nMany thanks to Andy Miller for initially creating the Learn theme for Grav.\nPackages and libraries autoComplete - A lightweight and powerful vanilla JavaScript completion suggester clipboard.js - A modern approach to copy text to clipboard Featherlight - A lightweight jQuery lightbox plugin Font Awesome - The internet’s icon library and toolkit jQuery - The “Write less, do more” JavaScript library jquery-svg-zoom-pan - A jQuery plugin to enable pan and zoom in SVG images Lunr - Enables a great search experience without the need for external, server-side, search services Mermaid - Generation of diagram and flowchart from text in a similar manner as markdown Perfect Scrollbar - A minimalistic but perfect custom scrollbar plugin RapiDoc - Create beautiful, customizable, interactive API documentation from OpenAPI Specifications Tooling GitHub - Continuous deployement, testing and hosting of this project’s sources and its documentation gren - A releasenotes generator for GitHub Hugo - The static site generator of your choice ",
"content":"The Expand shortcode displays an expandable/collapsible section of text on your page.\nUsage {{% expand [ \u003cstring\u003e [ \"true\" | \"false\" ] ] %}} Yes! {{% /expand %}} The first optional parameter defines the text that appears next to the expand/collapse icon. The default text is \"Expand me...\".\nThe second optional parameter controls if the block is initially shown as expanded (\"true\") or collapsed (\"false\"). The default ist \"false\".\nExamples I'll tell you a secret... …maybe the next time you’ll open this expander!\n All defaults Expand me... Yes, you did it!\n Show markup {{% expand %}} Yes, you did it! {{% /expand %}} Initially expanded Expand me... No need to press you!\n Show markup {{% expand \"Expand me...\" \"true\" %}} No need to press you! {{% /expand %}} Arbitrary text Show me almost endless possibilities Some expandable text.\nYou can add standard markdown syntax:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc. ...and even source code the possiblities are endless (almost - including other shortcodes may or may not work)\n Show markup {{% expand \"Show me almost endless possibilities\" %}} Some expandable text. You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even **_bold emphasized_** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless (almost - including other shortcodes may or may not work) {{% /expand %}} ",
"content":"Hugo Relearn Theme The Relearn theme is a theme for Hugo, a static website generator written in Go. Where Hugo is often used for blogs, this theme is designed with documentation in mind.\n Info The theme is a fork of the great Learn theme with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.\n Main features Tip See what’s new within the latest update.\n Usable offline, no external dependencies Support for Internet Explorer 11 Responsive design Configurable hidden pages Automatic next/prev buttons to navigate through menu entries Automatic Search Print whole chapters or even the complete site Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese Unrestricted menu configuration relating to amount of items and level of nesting Font Awesome icons Tagging support Image resizing, shadow… Syntax highlighting Attachments files List child pages Mermaid diagrams for flowcharts, sequences, gantts, pie, etc. Swagger UI for OpenAPI Specifications Customizable look and feel Predefined (light, dark) and customizable color variants Buttons Tip/Note/Info/Warning boxes Expand Tabs File inclusion Getting support To get support, feel free to open a new discussion topic or issue in the official repository on GitHub.\nBecome a contributor Feel free to update this documentation by just clicking the Edit link displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.\nYou are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the official repository via GitHub. Please visit the contribution guidelines first.\nLicense This theme is licensed under the MIT License.\nCredits This theme would not be possible without the work of many others. See the credits for a detailed list.\n",
"content":"Some testing for different styles of image links.\nMarkdown Relative to page Relative to page up level Static External fully qualified External without scheme External without scheme and scheme separator HTML Relative to page Relative to page up level Static External fully qualified External without scheme External without scheme and scheme separator ",
"description":"Some testing for different styles of image links",
"content":"The include shortcode includes other files from your project inside of the current file. This can even contain Markdown and will be taken into account when generating the table of contents.\nUsage {{% include \u003cstring\u003e [ \"true\" | \"false\" ] %}} The first required parameter is the path to the file to be included.\nIf the file’s content will be displayed as HTML, the second optional parameter controls if the first heading of the included file should be displayed (\"true\")- which is the default - or be hidden.\nExamples Arbitray content You can add standard markdown syntax:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc. ...and even source code the possiblities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)\n Show markup {{% include \"shortcodes/INCLUDE_ME.md\" %}} ",
"content":"Mermaid is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown.\n Note This only works in modern browsers.\n Warning Due to limitations with Mermaid, it is currently not possible to use Mermaid code fences in an initially collapsed expand shortcode. This is a know issue and can’t be fixed by this theme.\n Usage Just insert your Mermaid code in the mermaid shortcode like this:\n{{\u003c mermaid [ align=(\"left\"|\"right\"|\"center\"|\"justify\") ] \u003e}} classDiagram Person *-- Dog {{\u003c /mermaid \u003e}} You can set an optional align attribute which defaults to \"center\".\nIf you don’t need alignment you can use the alternative syntax using code fences if you have turned off guessSyntax for the markup.highlight setting (see below):\n```mermaid classDiagram Person *-- Dog ``` The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.\nExamples Flowchart %%{init:{\"theme\":\"forest\"}}%% graph LR; A[Hard edge] --|Link text| B(Round edge) B -- C{Decision} C --|One| D[Result one] C --|Two| E[Result two] Show markup {{\u003c mermaid align=\"left\" \u003e}} %%{init:{\"theme\":\"forest\"}}%%graphLR;A[Hardedge]--\u003e|Linktext|B(Roundedge)B--\u003eC{\u003cstrong\u003eDecision\u003c/strong\u003e}C--\u003e|One|D[Resultone]C--\u003e|Two|E[Resulttwo]{{\u003c/mermaid\u003e}}SequencesequenceDiagramparticipantAliceparticipantBobAlice-John:HelloJohn,howareyou?loopHealthcheckJohn-John:FightagainsthypochondriaendNoterightofJohn:Rationalthoughtsprevail...John--Alice:Great!John-Bob:Howaboutyou?Bob--John:Jollygood!Showmarkup{{\u003cmermaid\u003e}}sequenceDiagramparticipantAliceparticipantBobAlice-\u003e\u003eJohn:HelloJohn,howareyou?loopHealthcheckJohn-\u003eJohn:FightagainsthypochondriaendNoterightofJohn:Rationalthoughts\u003cbr/\u003eprevail...John--\u003eAlice:Great!John-\u003eBob:Howaboutyou?Bob--\u003eJohn:Jollygood!{{\u003c/mermaid\u003e}}GANTTganttdateFormatYYYY-MM-DDtitleAddingGANTTdiagramfunctionalitytoMermaidsectionAsectionCompletedtask:done,des1,2014-01-06,2014-01-08Activetask:active,des2,2014-01-09,3dFuturetask:des3,afterdes2,5dFuturetask2:des4,afterdes3,5dsectionCriticaltasksCompletedtaskinthecriticalline:crit,done,2014-01-06,24hImplementparserandjison:crit,done,afterdes1,2dCreatetestsforparser:crit,active,3dFuturetaskincriticalline:crit,5dCreatetestsforrenderer:2dAddtoMermaid:1dShowmarkup{{\u003cmermaid\u003e}}ganttdateFormatYYYY-MM-DDtitleAddingGANTTdiagramfunctionalitytoMermaidsectionAsectionCompletedtask:done,des1,2014-01-06,2014-01-08Activetask:active,des2,2014-01-09,3dFuturetask:des3,afterdes2,5dFuturetask2:des4,afterdes3,5dsectionCriticaltasksCompletedtaskinthecriticalline:crit,done,2014-01-06,24hImplementparserandjison:crit,done,afterdes1,2dCreatetestsforparser:crit,active,3dFuturetaskincriticalline:crit,5dCreatetestsforrenderer:2dAddtoMermaid:1d{{\u003c/mermaid\u003e}}ClassclassDiagramClass01C2:Whereami?Class09--*C3Class09--|Class07Class07:equals()Class07:Object[]elementDataClass01:size()Class01:intchimpClass01:intgorillaClass08C2:CoollabelShowmarkup{{\u003cmermaid\u003e}}classDiagramClass01\u003c|--AveryLongClass:CoolClass03*--Class04Class05o--Class06Class07..Class08Class09--\u003eC2:Whereami?Class09--*C3Class09--|\u003eClass07Class07:equals()Class07:Object[]elementDataClass01:size()Class01:intchimpClass01:intgorillaClass08\u003c--\u003eC2:Coollabel{{\u003c/mermaid\u003e}}StatestateDiagram-v2open:OpenDoorclosed:ClosedDoorlocked:LockedDooropen--closed:Closeclosed--locked:Locklocked--closed:Unlockclosed--open:OpenShowmarkup```mermaidstateDiagra
"content":"The notice shortcode shows various types of disclaimers with adjustable title and icon to help you structure your page.\n There may be pirates It is all about the boxes.\n Usage While the examples are using named parameter you are free to use positional aswell.\nnamed positional {{% notice style=\"primary\" title=\"There may be pirates\" icon=\"skull-crossbones\" %}} It is all about the boxes. {{% /notice %}} {{% notice primary \"There may be pirates\" \"skull-crossbones\" %}} It is all about the boxes. {{% /notice %}} Parameter Name Position Optional Default Notes style 1 yes default The color scheme used to highlight the box content.- by severity: info, note, tip, warning- by brand color: primary, secondary- by color: blue, green, grey, orange, red- by special color: default, transparent title 2 yes see notes Arbitray text for the box title. Depending on the style there may be a default title. Any given value will overwrite the default.- for severity styles: the matching title for the severity- for all other colors: no titleIf you want no title for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) icon 3 yes see notes Font Awesome icon name set to the left of the title. Depending on the style there may be a default icon. Any given value will overwrite the default.- for severity styles: a nice matching icon for the severity- for all other colors: no iconIf you want no icon for a severity style, you have to set this parameter to \" \" (a non empty string filled with spaces) Examples By Severity Info with markup Info An information disclaimer\nYou can add standard markdown syntax:\n multiple paragraphs bullet point lists emphasized, bold and even bold emphasized text links etc. ...and even source code the possiblities are endless (almost - including other shortcodes may or may not work)\n Show markup {{% notice style=\"info\" %}} An **information** disclaimer You can add standard markdown syntax: - multiple paragraphs - bullet point lists - _emphasized_, **bold** and even ***bold emphasized*** text - [links](https://example.com) - etc. ```plaintext ...and even source code ``` \u003e the possiblities are endless (almost - including other shortcodes may or may not work) {{% /notice %}} Note Note A notice disclaimer\n Show markup {{% notice style=\"note\" %}} A **notice** disclaimer {{% /notice %}} Tip Tip A tip disclaimer\n Show markup {{% notice style=\"tip\" %}} A **tip** disclaimer Warning Warning A warning disclaimer\n Show markup {{% notice style=\"warning\" %}} A **warning** disclaimer {{% /notice %}} Warning with non-default title and icon Here are dragons A warning disclaimer\n Show markup {{% notice style=\"warning\" title=\"Here are dragons\" icon=\"dragon\" %}} A **warning** disclaimer {{% /notice %}} Warning without a title and icon A warning disclaimer\n Show markup {{% notice style=\"warning\" title=\" \" icon=\" \" %}} A **warning** disclaimer {{% /notice %}} By Brand Colors Primary with title only Primary A primary disclaimer\n Show markup {{% notice style=\"primary\" title=\"Primary\" %}} A **primary** disclaimer {{% /notice %}} Secondary with icon only A secondary disclaimer\n Show markup {{% notice style=\"secondary\" icon=\"stopwatch\" %}} A **secondary** disclaimer {{% /notice %}} By Color Blue without a title and icon A blue disclaimer\n Show markup {{% notice style=\"blue\" %}} A **blue** disclaimer {{% /notice %}} Green with title only Green A green disclaimer\n Show markup {{% notice style=\"green\" title=\"Green\" %}} A **green** disclaimer {{% /notice %}} Grey with icon only A grey disclaimer\n Show markup {{% notice style=\"grey\" icon=\"bug\" %}} A **grey** disclaimer {{% /notice %}} Orange with title and icon Orange A orange disclaimer\n Show markup {{% notice style=\"orange\" title=\"Orange\" icon=\"bug\" %}} A **orange** disclaimer {{% /notice %}} Red A red disclaimer\n Show markup {{% notice style=\"red\
"description":"Disclaimers to help you structure your page",
"tags":null,
"title":"Notice",
"uri":"/hugo-theme-relearn/shortcodes/notice/"
},
{
"content":"This is a demo child page with a hidden child. You can still access the hidden child directly or via the search.\nSubpages of this page page 1-1-1 (hidden) page 1-1-2 page 1-1-3 ",
"content":"This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\nSubpages of this page page 1-1-1-1 ",
"content":"This is a non-hidden demo child page of a hidden parent page with a hidden child. You can still access the hidden child directly or via the search.\nSubpages of this page page 1-1-1-1-1 (hidden) ",
"description":"This is a non-hidden demo child page of a hidden parent page",
"content":"This is a hidden demo child page. This page and all its children are hidden in the menu, arrow navigation and children shortcode as long as you aren’t viewing this page or its children directly.\nSubpages of this page page 1-1-1-1-1-1 ",
"content":"The siteparam shortcode is used to help you print values of site params.\nUsage {{% siteparam \u003cstring\u003e %}} The first required parameter is the name of the site param to be displayed.\nExamples For instance, in this current site, the editURL variable is used in config.toml\n[params] editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" Use the siteparam shortcode to display its value.\n`editURL` Value : {{% siteparam \"editURL\" %}} is displayed as\neditURL Value : https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\n",
"content":"This shortcode uses the RapiDoc library to display your OpenAPI Specifications.\n Note This only works in modern browsers.\n Configuration Swagger is configured with default settings. You can customize Swagger’s default settings for all of your files thru a JSON object in your config.toml or override these settings per page thru your pages frontmatter.\nThe JSON object of your config.toml / frontmatter is forwarded into Swagger’s initialization. At the moment, only the theme setting is supported.\nThe theme setting can also be set by your used color variant. This will be the sitewide default and can - again - be overridden by your settings in config.toml or frontmatter.\nExample [params] swaggerInitialize = \"{ \\\"theme\\\": \\\"dark\\\" }\" Usage Just insert give the URL to your OpenAPI Specification like this:\n{{\u003c swagger src=\"https://petstore3.swagger.io/api/v3/openapi.json\" \u003e}} If your page is a leaf or branch bundle, you can also use relative URLs:\n{{\u003c swagger src=\"petstore.json\" \u003e}} The src parameter is mandatory and can be either an absolute or a relative URL.\nExample ",
"content":"Choose which content to see across the page. Very handy for providing code snippets for multiple languages or providing configuration in different formats.\nCode example {{\u003c tabs \u003e}} {{% tab name=\"python\" %}} ```python print(\"Hello World!\") ``` {{% /tab %}} {{% tab name=\"R\" %}} ```R \u003e print(\"Hello World!\") ``` {{% /tab %}} {{% tab name=\"Bash\" %}} ```Bash echo \"Hello World!\" ``` {{% /tab %}} {{\u003c /tabs \u003e}} Renders as:\npython R Bash print(\"Hello World!\") \u003e print(\"Hello World!\") echo \"Hello World!\" Tab views with the same tabs that belong to the same group sychronize their selection:\npython R Bash print(\"Hello World!\") \u003e print(\"Hello World!\") echo \"Hello World!\" Config example {{\u003c tabs groupId=\"config\" \u003e}} {{% tab name=\"json\" %}} ```json { \"Hello\": \"World\" } ``` {{% /tab %}} {{% tab name=\"XML\" %}} ```xml \u003cHello\u003eWorld\u003c/Hello\u003e ``` {{% /tab %}} {{% tab name=\"properties\" %}} ```properties Hello = World ``` {{% /tab %}} {{\u003c /tabs \u003e}} Renders as:\njson XML properties { \"Hello\": \"World\" } \u003cHello\u003eWorld\u003c/Hello\u003e Hello = World Warning When using tab views with different content sets, make sure to use a common groupId for equal sets but distinct groupId for different sets. The groupId defaults to 'default'. Take this into account across the whole site! The tab selection is restored automatically based on the groupId and if it cannot find a tab item because it came from the 'default' group on a different page then all tabs will be empty at first.\n ",
