diff --git a/404.html b/404.html index 820a08b41a..fdcec4542c 100644 --- a/404.html +++ b/404.html @@ -3,29 +3,29 @@ - + 404 Page not found :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - + - + - +
@@ -692,9 +692,9 @@
- - - + + +
- - - - - - + + + + + + - + diff --git a/basics/configuration/index.html b/basics/configuration/index.html index 677d675f2e..d32662b9c4 100644 --- a/basics/configuration/index.html +++ b/basics/configuration/index.html @@ -3,30 +3,30 @@ - + Configuration :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -81,72 +81,72 @@

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).

Note that some of these parameters are explained in details in other sections of this documentation.

-
[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 true, prevents Hugo from including the Mermaid module if not needed (will reduce load times and traffic)
-  disableMermaid = false
-  # Specifies the remote location of the Mermaid js
-  customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js"
-  # Initialization parameter for Mermaid, see Mermaid documentation
-  mermaidInitialize = "{ \"theme\": \"default\" }"
-  # 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"
-  # Provide a list of custom css files to load relative from the `static/` folder in the site root.
-  custom_css = ["css/foo.css", "css/bar.css"]
-  # Change the title separator. Default to "::".
-  titleSeparator = "-"
-

A word on running your site in a subfolder

+
[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 true, prevents Hugo from including the Mermaid module if not needed (will reduce load times and traffic)
+  disableMermaid = false
+  # Specifies the remote location of the Mermaid js
+  customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js"
+  # Initialization parameter for Mermaid, see Mermaid documentation
+  mermaidInitialize = "{ \"theme\": \"default\" }"
+  # 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"
+  # Provide a list of custom css files to load relative from the `static/` folder in the site root.
+  custom_css = ["css/foo.css", "css/bar.css"]
+  # Change the title separator. Default to "::".
+  titleSeparator = "-"
+

A word on running your site in a subfolder

The theme runs best if your site is installed in the root of your webserver. If your site is served from a subfolder, eg. https://example.com/mysite/, you have to set the following lines to your config.toml

-
baseURL = "https://example.com/mysite/"
-canonifyURLs = true
-

Without canonifyURLs=true URLs in sublemental pages (like sitemap.xml, rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.

+
baseURL = "https://example.com/mysite/"
+canonifyURLs = true
+

Without canonifyURLs=true URLs in sublemental pages (like sitemap.xml, rss.xml) will be generated falsly while your HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.

If not already present, add the follow lines in the same config.toml file.

-
[outputs]
-home = [ "HTML", "RSS", "JSON"]
-

Relearn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.

+
[outputs]
+home = [ "HTML", "RSS", "JSON"]
+

Relearn theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.

Hugo generate lunrjs index.json at the root of public folder. When you build the site with hugo server, hugo generates it internally and of course it doesn’t show up in the filesystem

@@ -163,22 +163,22 @@ On page “Architecture” you need a class diagram. You can set the Mer

If the disableLandingPageButton option is set to false, a Home button will appear on the left menu. It is an alternative for clicking on the logo. To edit the appearance, you will have to configure two parameters for the defined languages:

-
[Languages]
-[Languages.en]
-...
-landingPageURL = "/"
-landingPageName = "<i class='fas fa-home'></i> Home"
-...
-[Languages.pir]
-...
-landingPageURL = "/pir/"
-landingPageName = "<i class='fas fa-home'></i> Arrr! Homme"
-...
-

If those params are not configured for a specific language, they will get their +

[Languages]
+[Languages.en]
+...
+landingPageURL = "/"
+landingPageName = "<i class='fas fa-home'></i> Home"
+...
+[Languages.pir]
+...
+landingPageURL = "/pir/"
+landingPageName = "<i class='fas fa-home'></i> Arrr! Homme"
+...
+

If those params are not configured for a specific language, they will get their default values:

-
landingPageURL = "/"
-landingPageName = "<i class='fas fa-home'></i> Home"
-

The home button is going to look like this:

+
landingPageURL = "/"
+landingPageName = "<i class='fas fa-home'></i> Home"
+

The home button is going to look like this:

Default Home Button

@@ -260,9 +260,9 @@ default values:

- - - + + +
- - - - - - + + + + + + - + diff --git a/basics/customization/index.html b/basics/customization/index.html index f03ba1c015..c0bdf3e5a8 100644 --- a/basics/customization/index.html +++ b/basics/customization/index.html @@ -3,30 +3,30 @@ - + Customization :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -116,21 +116,21 @@ You could use an img HTML tag and reference an image created under

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.

If 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.

If you need to change this default behavior, create a new file in layouts/partials/ named favicon.html. Then write something like this:

-
<link rel="icon" href="/images/favicon.bmp" type="image/bmp" />
-

Change the colors

+
<link rel="icon" href="/images/favicon.bmp" type="image/bmp" />
+

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!

You can preview the shipped variants by changing them in the variant selector at the bottom of the menu.

Single variant

Set the themeVariant value with the name of your theme file. That’s it!

-
[params]
-  themeVariant = "relearn-light"
-

In the above exaple your theme file has to be named theme-relearn-light.css

+
[params]
+  themeVariant = "relearn-light"
+

In the above exaple your theme file has to be named theme-relearn-light.css

Multiple 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.

-
[params]
-  # Change default color scheme with a variant one.
-  themeVariant = [ "relearn-light", "relearn-dark" ]
-
+
[params]
+  # Change default color scheme with a variant one.
+  themeVariant = [ "relearn-light", "relearn-dark" ]
+
Tip
@@ -220,9 +220,9 @@ You could use an img HTML tag and reference an image created under
- - - + + +
- - - - - - + + + + + + - + diff --git a/basics/generator/index.html b/basics/generator/index.html index e466af2b0f..1b0a97f7d0 100644 --- a/basics/generator/index.html +++ b/basics/generator/index.html @@ -3,30 +3,30 @@ - + Stylesheet generator :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -178,9 +178,9 @@ variants.generator( '#vargenerator', '.vardownload', '.varreset' );
- - - + + +
- - - - - - + + + + + + - + diff --git a/basics/history/index.html b/basics/history/index.html index a5ea2cbab8..20f898d3f6 100644 --- a/basics/history/index.html +++ b/basics/history/index.html @@ -3,30 +3,30 @@ - + History :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -694,9 +694,9 @@
- - - + + +
- - - - - - + + + + + + - + diff --git a/basics/index.html b/basics/index.html index 9863047c51..177570fe5b 100644 --- a/basics/index.html +++ b/basics/index.html @@ -3,30 +3,30 @@ - + Basics :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -145,9 +145,9 @@
- - - + + +
- - - - - - + + + + + + - + diff --git a/basics/installation/index.html b/basics/installation/index.html index 437f57bddb..5646e8c8f2 100644 --- a/basics/installation/index.html +++ b/basics/installation/index.html @@ -3,30 +3,30 @@ - + Installation :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -90,34 +90,34 @@

Alternatively, you can download the theme as .zip file and extract it in the themes directory

Basic 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.

-
# 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

+
# 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.

-
### Chapter 1
-
-# Basics
-
-Discover what this Hugo theme is all about and the core concepts behind it.
-

renders as

+
### Chapter 1
+
+# Basics
+
+Discover what this Hugo theme is all about and the core concepts behind it.
+

renders as

A Chapter

The Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command

-
hugo 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.

+
hugo 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.

By 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.

Create your first content pages

Then, create content pages inside the previously created chapter. Here are two ways to create content in the chapter:

-
hugo 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.

+
hugo 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.

Launching the website locally

Launch by using the following command:

-
hugo serve
-

Go to http://localhost:1313

+
hugo serve
+

Go to http://localhost:1313

You should notice three things:

  1. You have a left-side Basics menu, containing two submenus with names equal to the title properties in the previously created files.
  2. @@ -126,8 +126,8 @@ hugo new basics/second-content/_index.md

Build the website

When your site is ready to deploy, run the following command:

-
hugo
-

A public folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.

+
hugo
+

A public folder will be generated, containing all static content and assets for your website. It can now be deployed on any web server.

Note
@@ -216,9 +216,9 @@ hugo new basics/second-content/_index.md
- - - + + +
- - - - - - + + + + + + - + diff --git a/basics/migration/index.html b/basics/migration/index.html index 483454a028..7c9c713da8 100644 --- a/basics/migration/index.html +++ b/basics/migration/index.html @@ -3,30 +3,30 @@ - + What's new :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -153,8 +153,8 @@

Also, the old themes implementation allowed refs to non-existing content. This will cause Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can reconfigure the error handling of Hugos implementation.

In the best case your usage of the old implementation is already standard complient and you don’t need to change anything. You’ll notice this very easily once you’ve started hugo server after an upgrade and no errors are written to the console.

You may see errors on the console after the update in the form:

-
ERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref "basics/configuration/_index.md": "hugo-theme-relearn\exampleSite\content\_index.en.md:19:22": page not found
-

In this case, you must apply one of two options:

+
ERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref "basics/configuration/_index.md": "hugo-theme-relearn\exampleSite\content\_index.en.md:19:22": page not found
+

In this case, you must apply one of two options:

  1. Copy the old implementation files theme/hugo-theme-relearn/layouts/shortcode/ref.html and theme/hugo-theme-relearn/layouts/shortcode/relref.html to your own projects layouts/shortcode/ref.html and layouts/shortcode/relref.html respectively. This is not recommended as your project will still rely on non-standard behavior afterwards.

    @@ -383,9 +383,9 @@
- - - + + +
- - - - - - + + + + + + - + diff --git a/basics/requirements/index.html b/basics/requirements/index.html index fef00cdf42..24fb38159b 100644 --- a/basics/requirements/index.html +++ b/basics/requirements/index.html @@ -3,30 +3,30 @@ - + Requirements :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -147,9 +147,9 @@
- - - + + +
- - - - - - + + + + + + - + diff --git a/categories/index.html b/categories/index.html index e82c6d2497..f31dba5ecf 100644 --- a/categories/index.html +++ b/categories/index.html @@ -3,30 +3,30 @@ - + Categories :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -138,9 +138,9 @@
- - - + + +
- - - - - - + + + + + + - + diff --git a/cont/archetypes/index.html b/cont/archetypes/index.html index 9e9e6ea3ad..b63d57f9c5 100644 --- a/cont/archetypes/index.html +++ b/cont/archetypes/index.html @@ -3,29 +3,29 @@ - + Archetypes :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -78,33 +78,33 @@

It is pre-configured skeleton pages with default front matter. Please refer to the documentation for types of page to understand the differences.

Chapter

To create a Chapter page, run the following commands

-
hugo new --kind chapter <name>/_index.md
-

It will create a page with predefined Front-Matter:

-
+++
-chapter = true
-pre = "<b>X. </b>"
-title = "{{ replace .Name "-" " " | title }}"
-weight = 5
-+++
-
-### Chapter X
-
-# Some Chapter title
-
-Lorem Ipsum.
-

Default

+
hugo new --kind chapter <name>/_index.md
+

It will create a page with predefined Front-Matter:

+
+++
+chapter = true
+pre = "<b>X. </b>"
+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

-
hugo new <chapter>/<name>/_index.md
-

or

-
hugo new <chapter>/<name>.md
-

It will create a page with predefined Front-Matter:

-
+++
-title = "{{ replace .Name "-" " " | title }}"
-weight = 5
-+++
-
-Lorem Ipsum.
-
@@ -184,9 +184,9 @@ - - - + + +
- - - - - - + + + + + + - + diff --git a/cont/i18n/index.html b/cont/i18n/index.html index 8dd6541249..4d203a0429 100644 --- a/cont/i18n/index.html +++ b/cont/i18n/index.html @@ -3,30 +3,30 @@ - + Multilingual and i18n :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -87,20 +87,20 @@

Basic configuration

After learning how Hugo handle multilingual websites, define your languages in your config.toml file.

For example with current English and Piratized English website.

-
# 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.

+
# 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.

@@ -220,9 +220,9 @@ - - - + + +
- - - - - - + + + + + + - + diff --git a/cont/icons/index.html b/cont/icons/index.html index d253c34f5b..a0e3026233 100644 --- a/cont/icons/index.html +++ b/cont/icons/index.html @@ -3,29 +3,29 @@ - + Icons and logos :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -80,11 +80,11 @@

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.

Once 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.

The HTML to include the heart icon is:

-
<i class="fas fa-heart"></i>
-

Including in markdown

+
<i class="fas fa-heart"></i>
+

Including in markdown

Paste the <i> HTML into markup and Font Awesome will load the relevant icon.

-
Built with <i class="fas fa-heart"></i> by Relearn and Hugo
-

Which appears as

+
Built with <i class="fas fa-heart"></i> by Relearn and Hugo
+

Which appears as

Built with by Relearn and Hugo

Customising icons

Font Awesome provides many ways to modify the icon

@@ -175,9 +175,9 @@
- - - + + +
- - - - - - + + + + + + - + diff --git a/cont/index.html b/cont/index.html index f7c0570630..bb4374db36 100644 --- a/cont/index.html +++ b/cont/index.html @@ -3,30 +3,30 @@ - + Content :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -145,9 +145,9 @@
- - - + + +
- - - - - - + + + + + + - + diff --git a/cont/markdown/index.html b/cont/markdown/index.html index 6d1de08c1f..7f7794725e 100644 --- a/cont/markdown/index.html +++ b/cont/markdown/index.html @@ -3,29 +3,29 @@ - + Markdown syntax :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
@@ -152,13 +152,13 @@

Headings

Headings from h1 through h6 are constructed with a # for each level:

-
# h1 Heading
-## h2 Heading
-### h3 Heading
-#### h4 Heading
-##### h5 Heading
-###### h6 Heading
-

Renders to:

+
# h1 Heading
+## h2 Heading
+### h3 Heading
+#### h4 Heading
+##### h5 Heading
+###### h6 Heading
+

Renders to:

h1 Heading

@@ -168,18 +168,18 @@
h5 Heading
h6 Heading

HTML:

-
<h1>h1 Heading</h1>
-<h2>h2 Heading</h2>
-<h3>h3 Heading</h3>
-<h4>h4 Heading</h4>
-<h5>h5 Heading</h5>
-<h6>h6 Heading</h6>
-

Comments

+
<h1>h1 Heading</h1>
+<h2>h2 Heading</h2>
+<h3>h3 Heading</h3>
+<h4>h4 Heading</h4>
+<h5>h5 Heading</h5>
+<h6>h6 Heading</h6>
+

Comments

Comments should be HTML compatible

-
<!--
-This is a comment
--->
-

Comment below should NOT be seen:

+
<!--
+This is a comment
+-->
+

Comment below should NOT be seen:

@@ -190,56 +190,56 @@ This is a comment

Paragraphs

Any text not starting with a special sign is written as normal, plain text and will be wrapped within <p></p> tags in the rendered HTML.

So this body copy:

-
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. 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.
-

renders to this HTML:

-
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. 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>
-

Text Markers

+
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. 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.
+

renders to this HTML:

+
<p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. 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>
+

Text Markers

Bold

For emphasizing a snippet of text with a heavier font-weight.

The following snippet of text is rendered as bold text.

-
**rendered as bold text**
-

renders to:

+
**rendered as bold text**
+

renders to:

rendered as bold text

and this HTML

-
<strong>rendered as bold text</strong>
-

Italics

+
<strong>rendered as bold text</strong>
+

Italics

For emphasizing a snippet of text with italics.

The following snippet of text is rendered as italicized text.

-
_rendered as italicized text_
-

renders to:

+
_rendered as italicized text_
+

renders to:

rendered as italicized text

and this HTML:

-
<em>rendered as italicized text</em>
-

Strikethrough

+
<em>rendered as italicized text</em>
+

Strikethrough

In GFM (GitHub flavored Markdown) you can do strikethroughs.

-
~~Strike through this text.~~
-

Which renders to:

+
~~Strike through this text.~~
+

Which renders to:

Strike through this text.

HTML:

-
<del>Strike through this text.</del>
-

Blockquotes

+
<del>Strike through this text.</del>
+

Blockquotes

For quoting blocks of content from another source within your document.

Add > before any text you want to quote.

-
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
-

Renders to:

+
> **Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
+

Renders to:

Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.

and this HTML:

-
<blockquote>
-  <p><strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.</p>
-</blockquote>
-

Blockquotes can also be nested:

-
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
->
-> > 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.
->
-> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
-

Renders to:

+
<blockquote>
+  <p><strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.</p>
+</blockquote>
+

Blockquotes can also be nested:

+
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
+>
+> > 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.
+>
+> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
+

Renders to:

Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.

@@ -251,23 +251,23 @@ This is a comment

Unordered

A list of items in which the order of the items does not explicitly matter.

You may use any of the following symbols to denote bullets for each list item:

-
* valid bullet
-- valid bullet
-+ valid bullet
-

For example

-
+ Lorem ipsum dolor sit amet
-+ Consectetur adipiscing elit
-+ Integer molestie lorem at massa
-+ Facilisis in pretium nisl aliquet
-+ Nulla volutpat aliquam velit
-  - Phasellus iaculis neque
-  - Purus sodales ultricies
-  - Vestibulum laoreet porttitor sem
-  - Ac tristique libero volutpat at
-+ Faucibus porta lacus fringilla vel
-+ Aenean sit amet erat nunc
-+ Eget porttitor lorem
-

Renders to:

+
* valid bullet
+- valid bullet
++ valid bullet
+

For example

+
+ Lorem ipsum dolor sit amet
++ Consectetur adipiscing elit
++ Integer molestie lorem at massa
++ Facilisis in pretium nisl aliquet
++ Nulla volutpat aliquam velit
+  - Phasellus iaculis neque
+  - Purus sodales ultricies
+  - Vestibulum laoreet porttitor sem
+  - Ac tristique libero volutpat at
++ Faucibus porta lacus fringilla vel
++ Aenean sit amet erat nunc
++ Eget porttitor lorem
+

Renders to:

And this HTML

-
<ul>
-  <li>Lorem ipsum dolor sit amet</li>
-  <li>Consectetur adipiscing elit</li>
-  <li>Integer molestie lorem at massa</li>
-  <li>Facilisis in pretium nisl aliquet</li>
-  <li>Nulla volutpat aliquam velit
-    <ul>
-      <li>Phasellus iaculis neque</li>
-      <li>Purus sodales ultricies</li>
-      <li>Vestibulum laoreet porttitor sem</li>
-      <li>Ac tristique libero volutpat at</li>
-    </ul>
-  </li>
-  <li>Faucibus porta lacus fringilla vel</li>
-  <li>Aenean sit amet erat nunc</li>
-  <li>Eget porttitor lorem</li>
-</ul>
-

Ordered

+
<ul>
+  <li>Lorem ipsum dolor sit amet</li>
+  <li>Consectetur adipiscing elit</li>
+  <li>Integer molestie lorem at massa</li>
+  <li>Facilisis in pretium nisl aliquet</li>
+  <li>Nulla volutpat aliquam velit
+    <ul>
+      <li>Phasellus iaculis neque</li>
+      <li>Purus sodales ultricies</li>
+      <li>Vestibulum laoreet porttitor sem</li>
+      <li>Ac tristique libero volutpat at</li>
+    </ul>
+  </li>
+  <li>Faucibus porta lacus fringilla vel</li>
+  <li>Aenean sit amet erat nunc</li>
+  <li>Eget porttitor lorem</li>
+</ul>
+

Ordered

A list of items in which the order of items does explicitly matter.

-
1. Lorem ipsum dolor sit amet
-4. Consectetur adipiscing elit
-2. Integer molestie lorem at massa
-8. Facilisis in pretium nisl aliquet
-4. Nulla volutpat aliquam velit
-99. Faucibus porta lacus fringilla vel
-21. Aenean sit amet erat nunc
-6. Eget porttitor lorem
-

Renders to:

+
1. Lorem ipsum dolor sit amet
+4. Consectetur adipiscing elit
+2. Integer molestie lorem at massa
+8. Facilisis in pretium nisl aliquet
+4. Nulla volutpat aliquam velit
+99. Faucibus porta lacus fringilla vel
+21. Aenean sit amet erat nunc
+6. Eget porttitor lorem
+

Renders to:

  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit
  3. @@ -327,17 +327,17 @@ This is a comment
  4. Eget porttitor lorem

And this HTML:

-
<ol>
-  <li>Lorem ipsum dolor sit amet</li>
-  <li>Consectetur adipiscing elit</li>
-  <li>Integer molestie lorem at massa</li>
-  <li>Facilisis in pretium nisl aliquet</li>
-  <li>Nulla volutpat aliquam velit</li>
-  <li>Faucibus porta lacus fringilla vel</li>
-  <li>Aenean sit amet erat nunc</li>
-  <li>Eget porttitor lorem</li>
-</ol>
-
+
<ol>
+  <li>Lorem ipsum dolor sit amet</li>
+  <li>Consectetur adipiscing elit</li>
+  <li>Integer molestie lorem at massa</li>
+  <li>Facilisis in pretium nisl aliquet</li>
+  <li>Nulla volutpat aliquam velit</li>
+  <li>Faucibus porta lacus fringilla vel</li>
+  <li>Aenean sit amet erat nunc</li>
+  <li>Eget porttitor lorem</li>
+</ol>
+
Tip
@@ -345,15 +345,15 @@ This is a comment
-
1. Lorem ipsum dolor sit amet
-1. Consectetur adipiscing elit
-1. Integer molestie lorem at massa
-1. Facilisis in pretium nisl aliquet
-1. Nulla volutpat aliquam velit
-1. Faucibus porta lacus fringilla vel
-1. Aenean sit amet erat nunc
-1. Eget porttitor lorem
-

Renders to:

+
1. Lorem ipsum dolor sit amet
+1. Consectetur adipiscing elit
+1. Integer molestie lorem at massa
+1. Facilisis in pretium nisl aliquet
+1. Nulla volutpat aliquam velit
+1. Faucibus porta lacus fringilla vel
+1. Aenean sit amet erat nunc
+1. Eget porttitor lorem
+

Renders to:

  1. Lorem ipsum dolor sit amet
  2. Consectetur adipiscing elit
  3. @@ -367,18 +367,18 @@ This is a comment

    Code

    Inline code

    Wrap inline snippets of code with `.

    -
    In this example, `<div></div>` should be wrapped as **code**.
    -

    Renders to:

    +
    In this example, `<div></div>` should be wrapped as **code**.
    +

    Renders to:

    In this example, <div></div> should be wrapped as code.

    HTML:

    -
    <p>In this example, <code>&lt;div&gt;&lt;/div&gt;</code> should be wrapped as <strong>code</strong>.</p>
    -

    Indented code

    +
    <p>In this example, <code>&lt;div&gt;&lt;/div&gt;</code> should be wrapped as <strong>code</strong>.</p>
    +

    Indented code

    Or indent several lines of code by at least two spaces, as in:

    -
        // Some comments
    -    line 1 of code
    -    line 2 of code
    -    line 3 of code
    -

    Renders to:

    +
        // Some comments
    +    line 1 of code
    +    line 2 of code
    +    line 3 of code
    +

    Renders to:

    // Some comments
     line 1 of code
    @@ -387,74 +387,74 @@ line 3 of code
     

    HTML:

    -
    <pre>
    -  <code>
    -    // Some comments
    -    line 1 of code
    -    line 2 of code
    -    line 3 of code
    -  </code>
    -</pre>
    -

    Block code “fences”

    +
    <pre>
    +  <code>
    +    // Some comments
    +    line 1 of code
    +    line 2 of code
    +    line 3 of code
    +  </code>
    +</pre>
    +

    Block code “fences”

    Use “fences” ``` to block in multiple lines of code.

    -
    ```
    -Sample text here...
    -```
    -

    HTML:

    -
    <pre>
    -  <code>Sample text here...</code>
    -</pre>
    -

    Syntax highlighting

    +
    ```
    +Sample text here...
    +```
    +

    HTML:

    +
    <pre>
    +  <code>Sample text here...</code>
    +</pre>
    +

    Syntax highlighting

    GFM, or “GitHub Flavored Markdown” also supports syntax highlighting. To activate it, usually you simply add the file extension of the language you want to use directly after the first code “fence”, ```js, and syntax highlighting will automatically be applied in the rendered HTML.

    See Code Highlighting for additional documentation.

    For example, to apply syntax highlighting to JavaScript code:

    -
    ```js
    -grunt.initConfig({
    -  assemble: {
    -    options: {
    -      assets: 'docs/assets',
    -      data: 'src/data/*.{json,yml}',
    -      helpers: 'src/custom-helpers.js',
    -      partials: ['src/partials/**/*.{hbs,md}']
    -    },
    -    pages: {
    -      options: {
    -        layout: 'default.hbs'
    -      },
    -      files: {
    -        './': ['src/templates/pages/index.hbs']
    -      }
    -    }
    -  }
    -};
    -```
    -

    Renders to:

    -
    grunt.initConfig({
    -  assemble: {
    -    options: {
    -      assets: 'docs/assets',
    -      data: 'src/data/*.{json,yml}',
    -      helpers: 'src/custom-helpers.js',
    -      partials: ['src/partials/**/*.{hbs,md}']
    -    },
    -    pages: {
    -      options: {
    -        layout: 'default.hbs'
    -      },
    -      files: {
    -        './': ['src/templates/pages/index.hbs']
    -      }
    -    }
    -  }
    -};
    -

    Tables

    +
    ```js
    +grunt.initConfig({
    +  assemble: {
    +    options: {
    +      assets: 'docs/assets',
    +      data: 'src/data/*.{json,yml}',
    +      helpers: 'src/custom-helpers.js',
    +      partials: ['src/partials/**/*.{hbs,md}']
    +    },
    +    pages: {
    +      options: {
    +        layout: 'default.hbs'
    +      },
    +      files: {
    +        './': ['src/templates/pages/index.hbs']
    +      }
    +    }
    +  }
    +};
    +```
    +

    Renders to:

    +
    grunt.initConfig({
    +  assemble: {
    +    options: {
    +      assets: 'docs/assets',
    +      data: 'src/data/*.{json,yml}',
    +      helpers: 'src/custom-helpers.js',
    +      partials: ['src/partials/**/*.{hbs,md}']
    +    },
    +    pages: {
    +      options: {
    +        layout: 'default.hbs'
    +      },
    +      files: {
    +        './': ['src/templates/pages/index.hbs']
    +      }
    +    }
    +  }
    +};
    +

    Tables

    Tables are created 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.

    -
    | Option | Description |
    -| ------ | ----------- |
    -| data   | path to data files to supply the data that will be passed into templates. |
    -| engine | engine to be used for processing templates. Handlebars is the default. |
    -| ext    | extension to be used for dest files. |
    -

    Renders to:

    +
    | Option | Description |
    +| ------ | ----------- |
    +| data   | path to data files to supply the data that will be passed into templates. |
    +| engine | engine to be used for processing templates. Handlebars is the default. |
    +| ext    | extension to be used for dest files. |
    +

    Renders to:

    @@ -478,32 +478,32 @@ grunt.initConfig({

    And this HTML:

    -
    <table>
    -  <tr>
    -    <th>Option</th>
    -    <th>Description</th>
    -  </tr>
    -  <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>
    -</table>
    -

    Right aligned text

    +
    <table>
    +  <tr>
    +    <th>Option</th>
    +    <th>Description</th>
    +  </tr>
    +  <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>
    +</table>
    +

    Right aligned text

    Adding a colon on the right side of the dashes below any heading will right align text for that column.

    -
    | Option | Description |
    -| ------:| -----------:|
    -| data   | path to data files to supply the data that will be passed into templates. |
    -| engine | engine to be used for processing templates. Handlebars is the default. |
    -| ext    | extension to be used for dest files. |
    -
    +
    | Option | Description |
    +| ------:| -----------:|
    +| data   | path to data files to supply the data that will be passed into templates. |
    +| engine | engine to be used for processing templates. Handlebars is the default. |
    +| ext    | extension to be used for dest files. |
    +
    @@ -556,44 +556,44 @@ grunt.initConfig({
    Option
    -
    [Assemble](http://assemble.io)
    -

    Renders to (hover over the link, there is no tooltip):

    +
    [Assemble](http://assemble.io)
    +

    Renders to (hover over the link, there is no tooltip):

    Assemble

    HTML:

    -
    <a href="http://assemble.io">Assemble</a>
    -

    Add a tooltip

    -
    [Upstage](https://github.com/upstage/ "Visit Upstage!")
    -

    Renders to (hover over the link, there should be a tooltip):

    +
    <a href="http://assemble.io">Assemble</a>
    +

    Add a tooltip

    +
    [Upstage](https://github.com/upstage/ "Visit Upstage!")
    +

    Renders to (hover over the link, there should be a tooltip):

    Upstage

    HTML:

    -
    <a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
    -

    Named Anchors

    +
    <a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
    +

    Named Anchors

    Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:

    -
    # Table of Contents
    -  * [Chapter 1](#chapter-1)
    -  * [Chapter 2](#chapter-2)
    -  * [Chapter 3](#chapter-3)
    -

    will jump to these sections:

    -
    ## Chapter 1 <a id="chapter-1"></a>
    -Content for chapter one.
    -
    -## Chapter 2 <a id="chapter-2"></a>
    -Content for chapter one.
    -
    -## Chapter 3 <a id="chapter-3"></a>
    -Content for chapter one.
    -

    NOTE that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.

    +
    # Table of Contents
    +  * [Chapter 1](#chapter-1)
    +  * [Chapter 2](#chapter-2)
    +  * [Chapter 3](#chapter-3)
    +

    will jump to these sections:

    +
    ## Chapter 1 <a id="chapter-1"></a>
    +Content for chapter one.
    +
    +## Chapter 2 <a id="chapter-2"></a>
    +Content for chapter one.
    +
    +## Chapter 3 <a id="chapter-3"></a>
    +Content for chapter one.
    +

    NOTE that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.

    Images

    Images have a similar syntax to links but include a preceding exclamation point.

    -
    ![Minion](https://octodex.github.com/images/minion.png)
    -

    Minion

    +
    ![Minion](https://octodex.github.com/images/minion.png)
    +

    Minion

    or

    -
    ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
    -

    Alt text

    +
    ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
    +

    Alt text

    Like links, Images also have a footnote style syntax

    Alternative usage : note images

    -
    ![Alt text][id]
    -

    Alt text

    +
    ![Alt text][id]
    +

    Alt text

    With a reference later in the document defining the URL location:

    [id]: https://octodex.github.com/images/dojocat.jpg  "The Dojocat"
     
    @@ -601,25 +601,25 @@ grunt.initConfig({

    The Hugo Markdown parser supports additional non-standard functionality.

    Resizing image

    Add HTTP parameters width and/or height to the link image to resize the image. Values are CSS values (default is auto).

    -
    ![Minion](https://octodex.github.com/images/minion.png?width=20pc)
    -

    Minion

    +
    ![Minion](https://octodex.github.com/images/minion.png?width=20pc)
    +

    Minion

    stormtroopocat

    -
    ![Minion](https://octodex.github.com/images/minion.png?height=50px)
    -

    Minion

    -
    ![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)
    -

    Minion

    +
    ![Minion](https://octodex.github.com/images/minion.png?height=50px)
    +

    Minion

    +
    ![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)
    +

    Minion

    Add CSS classes

    Add a HTTP classes parameter to the link image to add CSS classes. shadowand border are available but you could define other ones.

    -
    ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow)
    -

    stormtroopocat

    -
    ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border)
    -

    stormtroopocat

    -
    ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow)
    -

    stormtroopocat

    +
    ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow)
    +

    stormtroopocat

    +
    ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border)
    +

    stormtroopocat

    +
    ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow)
    +

    stormtroopocat

    Add a HTTP featherlight parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining featherlight to false.

    -
    ![Minion](https://octodex.github.com/images/minion.png?featherlight=false)
    -

    Minion

    +
    ![Minion](https://octodex.github.com/images/minion.png?featherlight=false)
    +

    Minion

    @@ -700,9 +700,9 @@ grunt.initConfig({ - - - + + +
      @@ -817,12 +817,12 @@ grunt.initConfig({
    - - - - - - + + + + + + - + diff --git a/cont/menushortcuts/index.html b/cont/menushortcuts/index.html index f66a98cb89..c52ffeafe5 100644 --- a/cont/menushortcuts/index.html +++ b/cont/menushortcuts/index.html @@ -3,29 +3,29 @@ - + Menu extra shortcuts :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -78,110 +78,110 @@

    Basic configuration

    Edit the website configuration config.toml and add a [[menu.shortcuts]] entry for each link your want to add.

    Example from the current website:

    -
    [[menu.shortcuts]]
    -name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
    -identifier = "ds"
    -url = "https://github.com/McShelby/hugo-theme-relearn"
    -weight = 10
    -
    -[[menu.shortcuts]]
    -name = "<i class='fas fa-fw fa-camera'></i> Showcases"
    -url = "more/showcase/"
    -weight = 11
    -
    -[[menu.shortcuts]]
    -name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
    -identifier = "hugodoc"
    -url = "https://gohugo.io/"
    -weight = 20
    -
    -[[menu.shortcuts]]
    -name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
    -url = "more/credits/"
    -weight = 30
    -
    -[[menu.shortcuts]]
    -name = "<i class='fas fa-fw fa-tags'></i> Tags"
    -url = "tags/"
    -weight = 40
    -

    By default, shortcuts are preceded by a title. This title can be disabled by setting disableShortcutsTitle=true. +

    [[menu.shortcuts]]
    +name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
    +identifier = "ds"
    +url = "https://github.com/McShelby/hugo-theme-relearn"
    +weight = 10
    +
    +[[menu.shortcuts]]
    +name = "<i class='fas fa-fw fa-camera'></i> Showcases"
    +url = "more/showcase/"
    +weight = 11
    +
    +[[menu.shortcuts]]
    +name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
    +identifier = "hugodoc"
    +url = "https://gohugo.io/"
    +weight = 20
    +
    +[[menu.shortcuts]]
    +name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
    +url = "more/credits/"
    +weight = 30
    +
    +[[menu.shortcuts]]
    +name = "<i class='fas fa-fw fa-tags'></i> 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.

    For example, in your local i18n/en.toml file, add the following content

    -
    [Shortcuts-Title]
    -other = "<Your value>"
    -

    Read more about hugo menu and hugo i18n translation strings

    +
    [Shortcuts-Title]
    +other = "<Your value>"
    +

    Read more about hugo menu and hugo i18n translation strings

    Configuration 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.<language-id>.

    Example from the current website:

    -
    [Languages]
    -  [Languages.en]
    -    title = "Hugo Relearn Theme"
    -    weight = 1
    -    languageName = "English"
    -    landingPageURL = "/"
    -    landingPageName = "<i class='fas fa-home'></i> Home"
    -
    -  [[Languages.en.menu.shortcuts]]
    -    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
    -    identifier = "ds"
    -    url = "https://github.com/McShelby/hugo-theme-relearn"
    -    weight = 10
    -
    -  [[Languages.en.menu.shortcuts]]
    -    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
    -    url = "more/showcase/"
    -    weight = 11
    -
    -  [[Languages.en.menu.shortcuts]]
    -    name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
    -    identifier = "hugodoc"
    -    url = "https://gohugo.io/"
    -    weight = 20
    -
    -  [[Languages.en.menu.shortcuts]]
    -    name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
    -    url = "more/credits/"
    -    weight = 30
    -
    -  [[Languages.en.menu.shortcuts]]
    -    name = "<i class='fas fa-fw fa-tags'></i> Tags"
    -    url = "tags/"
    -    weight = 40
    -
    -  [Languages.pir]
    -    title = "Cap'n Hugo Relearrrn Theme"
    -    weight = 1
    -    languageName = "Arrr! Pirrrates"
    -    landingPageURL = "/pir/"
    -    landingPageName = "<i class='fas fa-home'></i> Arrr! Home"
    -
    -  [[Languages.pir.menu.shortcuts]]
    -    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
    -    identifier = "ds"
    -    url = "https://github.com/McShelby/hugo-theme-relearn"
    -    weight = 10
    -
    -  [[Languages.pir.menu.shortcuts]]
    -    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
    -    url = "more/showcase/"
    -    weight = 11
    -
    -  [[Languages.pir.menu.shortcuts]]
    -    name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentat'n"
    -    identifier = "hugodoc"
    -    url = "https://gohugo.io/"
    -    weight = 20
    -
    -  [[Languages.pir.menu.shortcuts]]
    -    name = "<i class='fas fa-fw fa-bullhorn'></i> Crrredits"
    -    url = "more/credits/"
    -    weight = 30
    -
    -  [[Languages.pir.menu.shortcuts]]
    -    name = "<i class='fas fa-fw fa-tags'></i> Arrr! Tags"
    -    url = "tags/"
    -    weight = 40
    -

    Read more about hugo menu and hugo multilingual menus

    +
    [Languages]
    +  [Languages.en]
    +    title = "Hugo Relearn Theme"
    +    weight = 1
    +    languageName = "English"
    +    landingPageURL = "/"
    +    landingPageName = "<i class='fas fa-home'></i> Home"
    +
    +  [[Languages.en.menu.shortcuts]]
    +    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
    +    identifier = "ds"
    +    url = "https://github.com/McShelby/hugo-theme-relearn"
    +    weight = 10
    +
    +  [[Languages.en.menu.shortcuts]]
    +    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
    +    url = "more/showcase/"
    +    weight = 11
    +
    +  [[Languages.en.menu.shortcuts]]
    +    name = "<i class='fas fa-fw fa-bookmark'></i> Hugo Documentation"
    +    identifier = "hugodoc"
    +    url = "https://gohugo.io/"
    +    weight = 20
    +
    +  [[Languages.en.menu.shortcuts]]
    +    name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
    +    url = "more/credits/"
    +    weight = 30
    +
    +  [[Languages.en.menu.shortcuts]]
    +    name = "<i class='fas fa-fw fa-tags'></i> Tags"
    +    url = "tags/"
    +    weight = 40
    +
    +  [Languages.pir]
    +    title = "Cap'n Hugo Relearrrn Theme"
    +    weight = 1
    +    languageName = "Arrr! Pirrrates"
    +    landingPageURL = "/pir/"
    +    landingPageName = "<i class='fas fa-home'></i> Arrr! Home"
    +
    +  [[Languages.pir.menu.shortcuts]]
    +    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
    +    identifier = "ds"
    +    url = "https://github.com/McShelby/hugo-theme-relearn"
    +    weight = 10
    +
    +  [[Languages.pir.menu.shortcuts]]
    +    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
    +    url = "more/showcase/"
    +    weight = 11
    +
    +  [[Languages.pir.menu.shortcuts]]
    +    name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentat'n"
    +    identifier = "hugodoc"
    +    url = "https://gohugo.io/"
    +    weight = 20
    +
    +  [[Languages.pir.menu.shortcuts]]
    +    name = "<i class='fas fa-fw fa-bullhorn'></i> Crrredits"
    +    url = "more/credits/"
    +    weight = 30
    +
    +  [[Languages.pir.menu.shortcuts]]
    +    name = "<i class='fas fa-fw fa-tags'></i> Arrr! Tags"
    +    url = "tags/"
    +    weight = 40
    +

    Read more about hugo menu and hugo multilingual menus

    @@ -262,9 +262,9 @@ However, if you want to keep the title but change its value, it can be overriden - - - + + +
      @@ -379,12 +379,12 @@ However, if you want to keep the title but change its value, it can be overriden
    - - - - - - + + + + + + - + diff --git a/cont/pages/index.html b/cont/pages/index.html index f752b0b205..5c33a4ccf3 100644 --- a/cont/pages/index.html +++ b/cont/pages/index.html @@ -3,30 +3,30 @@ - + Pages organization :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -93,30 +93,30 @@

    In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.

    Folders

    Organize your site like any other Hugo project. Typically, you will have a content folder with all your pages.

    -
    content
    -├── level-one
    -│   ├── level-two
    -│   │   ├── level-three
    -│   │   │   ├── level-four
    -│   │   │   │   ├── _index.md       <-- /level-one/level-two/level-three/level-four
    -│   │   │   │   ├── page-4-a.md     <-- /level-one/level-two/level-three/level-four/page-4-a
    -│   │   │   │   ├── page-4-b.md     <-- /level-one/level-two/level-three/level-four/page-4-b
    -│   │   │   │   └── page-4-c.md     <-- /level-one/level-two/level-three/level-four/page-4-c
    -│   │   │   ├── _index.md           <-- /level-one/level-two/level-three
    -│   │   │   ├── page-3-a.md         <-- /level-one/level-two/level-three/page-3-a
    -│   │   │   ├── page-3-b.md         <-- /level-one/level-two/level-three/page-3-b
    -│   │   │   └── page-3-c.md         <-- /level-one/level-two/level-three/page-3-c
    -│   │   ├── _index.md               <-- /level-one/level-two
    -│   │   ├── page-2-a.md             <-- /level-one/level-two/page-2-a
    -│   │   ├── page-2-b.md             <-- /level-one/level-two/page-2-b
    -│   │   └── page-2-c.md             <-- /level-one/level-two/page-2-c
    -│   ├── _index.md                   <-- /level-one
    -│   ├── page-1-a.md                 <-- /level-one/page-1-a
    -│   ├── page-1-b.md                 <-- /level-one/page-1-b
    -│   └── page-1-c.md                 <-- /level-one/page-1-c
    -├── _index.md                       <-- /
    -└── page-top.md                     <-- /page-top
    -
    +
    content
    +├── level-one
    +│   ├── level-two
    +│   │   ├── level-three
    +│   │   │   ├── level-four
    +│   │   │   │   ├── _index.md       <-- /level-one/level-two/level-three/level-four
    +│   │   │   │   ├── page-4-a.md     <-- /level-one/level-two/level-three/level-four/page-4-a
    +│   │   │   │   ├── page-4-b.md     <-- /level-one/level-two/level-three/level-four/page-4-b
    +│   │   │   │   └── page-4-c.md     <-- /level-one/level-two/level-three/level-four/page-4-c
    +│   │   │   ├── _index.md           <-- /level-one/level-two/level-three
    +│   │   │   ├── page-3-a.md         <-- /level-one/level-two/level-three/page-3-a
    +│   │   │   ├── page-3-b.md         <-- /level-one/level-two/level-three/page-3-b
    +│   │   │   └── page-3-c.md         <-- /level-one/level-two/level-three/page-3-c
    +│   │   ├── _index.md               <-- /level-one/level-two
    +│   │   ├── page-2-a.md             <-- /level-one/level-two/page-2-a
    +│   │   ├── page-2-b.md             <-- /level-one/level-two/page-2-b
    +│   │   └── page-2-c.md             <-- /level-one/level-two/page-2-c
    +│   ├── _index.md                   <-- /level-one
    +│   ├── page-1-a.md                 <-- /level-one/page-1-a
    +│   ├── page-1-b.md                 <-- /level-one/page-1-b
    +│   └── page-1-c.md                 <-- /level-one/page-1-c
    +├── _index.md                       <-- /
    +└── page-top.md                     <-- /page-top
    +
    Note
    @@ -130,81 +130,81 @@

    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.

    You can define any HTML as prefix for the menu. In the example below, it’s just a number but that could be an icon.

    Chapter page

    -
    +++
    -chapter = true
    -pre = "<b>1. </b>"
    -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.

    +
    +++
    +chapter = true
    +pre = "<b>1. </b>"
    +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.

    Default

    A Default page is any other content page.

    Default page

    -
    +++
    -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.

    +
    +++
    +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.

    Create your project

    Hugo provides a new command to create a new website.

    -
    hugo new site <new_project>
    -

    The Relearn theme provides archetypes to help you create this kind of pages.

    +
    hugo new site <new_project>
    +

    The Relearn theme provides archetypes to help you create this kind of pages.

    Front Matter configuration

    Each Hugo page has to define a Front Matter in toml, yaml or json. This site will use toml in all cases.

    The Relearn theme uses the following parameters on top of Hugo ones :

    -
    +++
    -# 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 = ""
    -# Set the page as a chapter, changing the way it's displayed
    -chapter = false
    -# Hide a menu entry by setting this to true
    -hidden = false
    -# Display name of this page modifier. If set, it will be displayed in the footer.
    -LastModifierDisplayName = ""
    -# Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer
    -LastModifierEmail = ""
    -+++
    -

    Add icon to a menu entry

    +
    +++
    +# 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 = ""
    +# Set the page as a chapter, changing the way it's displayed
    +chapter = false
    +# Hide a menu entry by setting this to true
    +hidden = false
    +# Display name of this page modifier. If set, it will be displayed in the footer.
    +LastModifierDisplayName = ""
    +# Email of this page modifier. If set with LastModifierDisplayName, it will be displayed in the footer
    +LastModifierEmail = ""
    ++++
    +

    Add icon to a menu entry

    In the page frontmatter, add a pre param to insert any HTML code before the menu label. The example below uses the GitHub icon.

    -
    +++
    -title = "GitHub repo"
    -pre = "<i class='fab fa-github'></i> "
    -+++
    -

    Title with icon

    +
    +++
    +title = "GitHub repo"
    +pre = "<i class='fab fa-github'></i> "
    ++++
    +

    Title with icon

    Ordering sibling menu/page entries

    Hugo provides a flexible way to handle order for your pages.

    The simplest way is to set weight parameter to a number.

    -
    +++
    -title = "My page"
    -weight = 5
    -+++
    -

    Using a custom title for menu entries

    +
    +++
    +title = "My page"
    +weight = 5
    ++++
    +

    Using a custom title for menu entries

    By default, the Relearn theme will use a page’s title attribute for the menu item (or linkTitle if defined).

    But a page’s title has to be descriptive on its own while the menu is a hierarchy. We’ve added the menuTitle parameter for that purpose:

    For example (for a page named content/install/linux.md):

    -
    +++
    -title = "Install on Linux"
    -menuTitle = "Linux"
    -+++
    -

    Override expand state rules for menu entries

    +
    +++
    +title = "Install on Linux"
    +menuTitle = "Linux"
    ++++
    +

    Override expand state rules for menu entries

    You can change how the theme expands menu entries on the side of the content with the alwaysopen setting on a per page basis. If alwaysopen=false 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.

    The theme generates the menu based on the following rules:

      @@ -303,9 +303,9 @@ We’ve added the menuTitle parameter for that purpose:

    - - - + + +
      @@ -420,12 +420,12 @@ We’ve added the menuTitle parameter for that purpose:

    - - - - - - + + + + + + - + diff --git a/cont/syntaxhighlight/index.html b/cont/syntaxhighlight/index.html index c7c58f6b13..b6c07d9f17 100644 --- a/cont/syntaxhighlight/index.html +++ b/cont/syntaxhighlight/index.html @@ -3,29 +3,29 @@ - + Code highlighting :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -79,48 +79,48 @@

    Markdown 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.

    -
    ```json
    -[
    -  {
    -    "title": "apples",
    -    "count": [12000, 20000],
    -    "description": {"text": "...", "sensitive": false}
    -  },
    -  {
    -    "title": "oranges",
    -    "count": [17500, null],
    -    "description": {"text": "...", "sensitive": false}
    -  }
    -]
    -```
    -
    +
    ```json
    +[
    +  {
    +    "title": "apples",
    +    "count": [12000, 20000],
    +    "description": {"text": "...", "sensitive": false}
    +  },
    +  {
    +    "title": "oranges",
    +    "count": [17500, null],
    +    "description": {"text": "...", "sensitive": false}
    +  }
    +]
    +```
    +

    Renders to:

    -
    [
    -  {
    -    "title": "apples",
    -    "count": [12000, 20000],
    -    "description": {"text": "...", "sensitive": false}
    -  },
    -  {
    -    "title": "oranges",
    -    "count": [17500, null],
    -    "description": {"text": "...", "sensitive": false}
    -  }
    -]
    -

    Supported languages

    +
    [
    +  {
    +    "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.

    You can choose a color theme from the list of supported themes and add it in your config.toml

    -
    [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"
    -
    +
    [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"
    +
    @@ -200,9 +200,9 @@ - - - + + +
      @@ -317,12 +317,12 @@
    - - - - - - + + + + + + - + diff --git a/cont/tags/index.html b/cont/tags/index.html index e3138aebc9..fecacd21ff 100644 --- a/cont/tags/index.html +++ b/cont/tags/index.html @@ -3,29 +3,29 @@ - + Tags :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -82,21 +82,21 @@

    The Relearn theme supports one default taxonomy of Hugo: the tag feature.

    Configuration

    Just add tags to any page:

    -
    +++
    -tags = ["tutorial", "theme"]
    -title = "Theme tutorial"
    -weight = 15
    -+++
    -

    Behavior

    +
    +++
    +tags = ["tutorial", "theme"]
    +title = "Theme tutorial"
    +weight = 15
    ++++
    +

    Behavior

    The tags are displayed at the top of the page, in their insertion order.

    Each tag is a link to a Taxonomy page displaying all the articles with the given tag.

    List all the tags

    In the config.toml file you can add a shortcut to display all the tags

    -
    [[menu.shortcuts]]
    -name = "<i class='fas fa-tags'></i> Tags"
    -url = "/tags"
    -weight = 30
    -
    +
    [[menu.shortcuts]]
    +name = "<i class='fas fa-tags'></i> Tags"
    +url = "/tags"
    +weight = 30
    +
    @@ -176,9 +176,9 @@ - - - + + +
      @@ -293,12 +293,12 @@
    - - - - - - + + + + + + - + diff --git a/css/variant.css b/css/variant.css index a2cd8cd055..d3420b0147 100644 --- a/css/variant.css +++ b/css/variant.css @@ -180,7 +180,7 @@ div.featherlight .featherlight-content{ background-color: var(--INTERNAL-MAIN-BG-color); } -body #top-bar { +body #topbar { background-color: var(--INTERNAL-MAIN-BG-color); } diff --git a/index.html b/index.html index 65726f58a1..8f6a9060be 100644 --- a/index.html +++ b/index.html @@ -3,30 +3,30 @@ - + Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -201,9 +201,9 @@
    - - - + + +
      @@ -318,12 +318,12 @@
    - - - - - - + + + + + + - + diff --git a/more/credits/index.html b/more/credits/index.html index 63b123d632..58c6a88337 100644 --- a/more/credits/index.html +++ b/more/credits/index.html @@ -3,30 +3,30 @@ - + Credits :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -162,9 +162,9 @@
    - - - + + +
      @@ -279,12 +279,12 @@
    - - - - - - + + + + + + - + diff --git a/more/showcase/index.html b/more/showcase/index.html index 5a7ca40d8d..2100f2c167 100644 --- a/more/showcase/index.html +++ b/more/showcase/index.html @@ -3,30 +3,30 @@ - + Showcase :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -158,9 +158,9 @@
    - - - + + +
      @@ -275,12 +275,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/404.html b/pir/404.html index 98d7603cc0..d40992e343 100644 --- a/pir/404.html +++ b/pir/404.html @@ -3,29 +3,29 @@ - + 404 Page not found :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - + - + - +
    @@ -75,72 +75,72 @@

    Global ship parameters

    On top o' Cap'n Hugo global configurat'n, th' Relearrrn theme lets ye define th' follow'n parameters 'n yer config.toml (here, values be default).

    Avast that some o' these parameters be explained 'n details 'n other sections o' this documentat'n.

    -
    [params]
    -  # This controls whether submenus will be expanded (true), or collapsed (false) 'n th'
    -  # menu; if no sett'n be given, th' first menu level be set t' false, all others t' true;
    -  # this can be overridden 'n th' planks frontmatter
    -  alwaysopen = true
    -  # Prefix URL t' edit current plank. Will display an "Edit" button on top right hand corner o' every plank.
    -  # Useful t' give opportunity t' people t' create merge request fer yer doc.
    -  # See th' config.toml file from this documentat'n ship t' have an example.
    -  editURL = ""
    -  # Author o' th' ship, will be used 'n meta informat'n
    -  author = ""
    -  # Descript'n o' th' ship, will be used 'n meta informat'n
    -  descript'n = ""
    -  # Shows a checkmark fer visited planks on th' menu
    -  showVisitedLinks = false
    -  # Dis'ble search funct'n. It will hide search bar
    -  disableSearch = false
    -  # Dis'ble search 'n hidden planks, otherwise they will be shown 'n search box
    -  disableSearchHiddenPages = false
    -  # Disables hidden planks from show'n up 'n th' sitemap an' on Google (et all), otherwise they may be indexed by search engines
    -  disableSeoHiddenPages = false
    -  # Disables hidden planks from show'n up on th' tags plank although th' tag term will be displayed even if all planks be hidden
    -  disableTagHiddenPages = false
    -  # Javascript an' CSS cache be automatically busted when new version o' ship be generated.
    -  # Set this t' true t' dis'ble this behavior (some proxies don't handle well this optimization)
    -  disableAssetsBust'n = false
    -  # Set this t' true t' dis'ble copy-to-clipboard button fer inline code.
    -  disableInlineCopyToClipBoard = false
    -  # A title fer shortcuts 'n menu be set by default. Set this t' true t' dis'ble it.
    -  disableShortcutsTitle = false
    -  # If set t' false, a Home button will appear below th' search bar on th' menu.
    -  # It be redirect'n t' th' land'n plank o' th' current language if specified. (Default be "/")
    -  disableLandingPageButton = true
    -  # When us'n mulitlingual website, dis'ble th' switch language button.
    -  disableLanguageSwitchingButton = false
    -  # Hide breadcrumbs 'n th' header an' only show th' current plank title
    -  disableBreadcrumb = true
    -  # If set t' true, hide t'ble o' contents menu 'n th' header o' all planks
    -  disableToc = false
    -  # If set t' true, prevents Cap'n Hugo from includ'n th' Merrrmaid module if not needed (will reduce board times an' traffic)
    -  disableMermaid = false
    -  # Specifies th' remote locat'n o' th' Merrrmaid js
    -  customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js"
    -  # Initializat'n parameter fer Merrrmaid, see Merrrmaid documentat'n
    -  mermaidInitialize = "{ \"theme\": \"default\" }"
    -  # Hide Next an' Previous plank buttons normally displayed full height beside rrrambl'n
    -  disableNextPrev = true
    -  # Order sections 'n menu by "weight" or "title". Default t' "weight";
    -  # this can be overridden 'n th' planks frontmatter
    -  ordersectionsby = "weight"
    -  # Change default color scheme wit' a variant one. Eg. can be "red", "blue", "green" or an array like [ "blue", "green" ].
    -  themeVariant = "relearn-light"
    -  # Provide a list o' custom css files t' board relative from th' `static/` folder 'n th' ship root.
    -  custom_css = ["css/foo.css", "css/bar.css"]
    -  # Change th' title separator. Default t' "::".
    -  titleSeparator = "-"
    -

    A word on runn'n yer ship 'n a subfolder

    +
    [params]
    +  # This controls whether submenus will be expanded (true), or collapsed (false) 'n th'
    +  # menu; if no sett'n be given, th' first menu level be set t' false, all others t' true;
    +  # this can be overridden 'n th' planks frontmatter
    +  alwaysopen = true
    +  # Prefix URL t' edit current plank. Will display an "Edit" button on top right hand corner o' every plank.
    +  # Useful t' give opportunity t' people t' create merge request fer yer doc.
    +  # See th' config.toml file from this documentat'n ship t' have an example.
    +  editURL = ""
    +  # Author o' th' ship, will be used 'n meta informat'n
    +  author = ""
    +  # Descript'n o' th' ship, will be used 'n meta informat'n
    +  descript'n = ""
    +  # Shows a checkmark fer visited planks on th' menu
    +  showVisitedLinks = false
    +  # Dis'ble search funct'n. It will hide search bar
    +  disableSearch = false
    +  # Dis'ble search 'n hidden planks, otherwise they will be shown 'n search box
    +  disableSearchHiddenPages = false
    +  # Disables hidden planks from show'n up 'n th' sitemap an' on Google (et all), otherwise they may be indexed by search engines
    +  disableSeoHiddenPages = false
    +  # Disables hidden planks from show'n up on th' tags plank although th' tag term will be displayed even if all planks be hidden
    +  disableTagHiddenPages = false
    +  # Javascript an' CSS cache be automatically busted when new version o' ship be generated.
    +  # Set this t' true t' dis'ble this behavior (some proxies don't handle well this optimization)
    +  disableAssetsBust'n = false
    +  # Set this t' true t' dis'ble copy-to-clipboard button fer inline code.
    +  disableInlineCopyToClipBoard = false
    +  # A title fer shortcuts 'n menu be set by default. Set this t' true t' dis'ble it.
    +  disableShortcutsTitle = false
    +  # If set t' false, a Home button will appear below th' search bar on th' menu.
    +  # It be redirect'n t' th' land'n plank o' th' current language if specified. (Default be "/")
    +  disableLandingPageButton = true
    +  # When us'n mulitlingual website, dis'ble th' switch language button.
    +  disableLanguageSwitchingButton = false
    +  # Hide breadcrumbs 'n th' header an' only show th' current plank title
    +  disableBreadcrumb = true
    +  # If set t' true, hide t'ble o' contents menu 'n th' header o' all planks
    +  disableToc = false
    +  # If set t' true, prevents Cap'n Hugo from includ'n th' Merrrmaid module if not needed (will reduce board times an' traffic)
    +  disableMermaid = false
    +  # Specifies th' remote locat'n o' th' Merrrmaid js
    +  customMermaidURL = "https://unpkg.com/mermaid@8.8.0/dist/mermaid.min.js"
    +  # Initializat'n parameter fer Merrrmaid, see Merrrmaid documentat'n
    +  mermaidInitialize = "{ \"theme\": \"default\" }"
    +  # Hide Next an' Previous plank buttons normally displayed full height beside rrrambl'n
    +  disableNextPrev = true
    +  # Order sections 'n menu by "weight" or "title". Default t' "weight";
    +  # this can be overridden 'n th' planks frontmatter
    +  ordersectionsby = "weight"
    +  # Change default color scheme wit' a variant one. Eg. can be "red", "blue", "green" or an array like [ "blue", "green" ].
    +  themeVariant = "relearn-light"
    +  # Provide a list o' custom css files t' board relative from th' `static/` folder 'n th' ship root.
    +  custom_css = ["css/foo.css", "css/bar.css"]
    +  # Change th' title separator. Default t' "::".
    +  titleSeparator = "-"
    +

    A word on runn'n yer ship 'n a subfolder

    Th' theme runs best if yer ship be installed 'n th' root o' yer webserver. If yer ship be served from a subfolder, eg. https://example.com/mysite/, ye have t' set th' follow'n lines t' yer config.toml

    -
    baseURL = "https://example.com/mysite/"
    -canonifyURLs = true
    -

    Without canonifyURLs=true URLs 'n sublemental planks (like sitemap.xml, rss.xml) will be generated falsly while yer HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.

    +
    baseURL = "https://example.com/mysite/"
    +canonifyURLs = true
    +

    Without canonifyURLs=true URLs 'n sublemental planks (like sitemap.xml, rss.xml) will be generated falsly while yer HTML files will still work. See https://github.com/gohugoio/hugo/issues/5226.

    If not already present, add th' follow lines 'n th' same config.toml file.

    -
    [outputs]
    -home = [ "HTML", "RSS", "JSON"]
    -

    Relearrrn theme uses th' last improvement avail'ble 'n hugo version 20+ t' generate a json index file ready t' be consumed by lunr.js javascript search engine.

    +
    [outputs]
    +home = [ "HTML", "RSS", "JSON"]
    +

    Relearrrn theme uses th' last improvement avail'ble 'n hugo version 20+ t' generate a json index file ready t' be consumed by lunr.js javascript search engine.

    Cap'n Hugo generate lunrjs index.json at th' root o' public folder. When ye build th' ship wit' hugo server, hugo generates it internally an' o' course it doesn’t show up 'n th' filesystem

    @@ -157,22 +157,22 @@ On plank “Architecture” ye need a class diagram. Ye can set th' Merr

    If th' disableLandingPageButton opt'n be set t' false, a Home button will appear on th' left menu. It be an alternative fer click'n on th' logo. T' edit th' appearance, ye will have t' configure two parameters fer th' defined languages:

    -
    [Languages]
    -[Languages.en]
    -...
    -landingPageURL = "/"
    -landingPageName = "<i class='fas fa-home'></i> Home"
    -...
    -[Languages.pir]
    -...
    -landingPageURL = "/pir/"
    -landingPageName = "<i class='fas fa-home'></i> Arrr! Homme"
    -...
    -

    If those params be not configured fer a specific language, they will get their +

    [Languages]
    +[Languages.en]
    +...
    +landingPageURL = "/"
    +landingPageName = "<i class='fas fa-home'></i> Home"
    +...
    +[Languages.pir]
    +...
    +landingPageURL = "/pir/"
    +landingPageName = "<i class='fas fa-home'></i> Arrr! Homme"
    +...
    +

    If those params be not configured fer a specific language, they will get their default values:

    -
    landingPageURL = "/"
    -landingPageName = "<i class='fas fa-home'></i> Home"
    -

    Th' home button be go'n t' look like this:

    +
    landingPageURL = "/"
    +landingPageName = "<i class='fas fa-home'></i> Home"
    +

    Th' home button be go'n t' look like this:

    Default Home Button

    @@ -255,9 +255,9 @@ default values:

    - - - + + +
      @@ -372,12 +372,12 @@ default values:

    - - - - - - + + + + + + - + diff --git a/pir/basics/customization/index.html b/pir/basics/customization/index.html index b5e0aa489d..932956c8cc 100644 --- a/pir/basics/customization/index.html +++ b/pir/basics/customization/index.html @@ -3,30 +3,30 @@ - + Customizat'n :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -106,21 +106,21 @@ Ye could use an img HTML tag an' reference an image created under t

    If yer favicon be a SVG, PNG or ICO, just drop off yer image 'n yer local static/images/ folder an' name it favicon.svg, favicon.png or favicon.ico respectivly.

    If no favicon file be found, th' theme will lookup th' alternative filename logo 'n th' same locat'n an' will repeat th' search fer th' list o' supported file types.

    If ye need t' change this default behavior, create a new file 'n layouts/partials/ named favicon.html. Then write someth'n like this:

    -
    <link rel="icon" href="/images/favicon.bmp" type="image/bmp" />
    -

    Change th' colors

    +
    <link rel="icon" href="/images/favicon.bmp" type="image/bmp" />
    +

    Change th' colors

    Th' Relearrrn theme lets ye choose between some predefined color variants 'n light or dark mode, but feel free t' add one yourself!

    Ye can preview th' shipped variants by chang'n them 'n th' variant selector at th' bottom o' th' menu.

    Single variant

    Set th' themeVariant value wit' th' name o' yer theme file. That’s it!

    -
    [params]
    -  themeVariant = "relearn-light"
    -

    In th' above exaple yer theme file has t' be named theme-relearn-light.css

    +
    [params]
    +  themeVariant = "relearn-light"
    +

    In th' above exaple yer theme file has t' be named theme-relearn-light.css

    Multiple variants

    Ye can also set multiple variants. In this case, th' first variant be th' default choosen on first view an' a variant switch will be shown 'n th' menu footer.

    -
    [params]
    -  # Change default color scheme wit' a variant one.
    -  themeVariant = [ "relearn-light", "relearn-dark" ]
    -
    +
    [params]
    +  # Change default color scheme wit' a variant one.
    +  themeVariant = [ "relearn-light", "relearn-dark" ]
    +
    Smarrrt Arrrse
    @@ -211,9 +211,9 @@ Ye could use an img HTML tag an' reference an image created under t
    - - - + + +
      @@ -328,12 +328,12 @@ Ye could use an img HTML tag an' reference an image created under t
    - - - - - - + + + + + + - + diff --git a/pir/basics/generator/index.html b/pir/basics/generator/index.html index 756fd60596..d005b2f28a 100644 --- a/pir/basics/generator/index.html +++ b/pir/basics/generator/index.html @@ -3,30 +3,30 @@ - + Stylesheet generrrat'r :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -177,9 +177,9 @@ variants.generator( '#vargenerator', '.vardownload', '.varreset' );
    - - - + + +
      @@ -294,12 +294,12 @@ variants.generator( '#vargenerator', '.vardownload', '.varreset' );
    - - - - - - + + + + + + - + diff --git a/pir/basics/history/index.html b/pir/basics/history/index.html index 722eb232a1..13eda1c7aa 100644 --- a/pir/basics/history/index.html +++ b/pir/basics/history/index.html @@ -3,30 +3,30 @@ - + Historrry :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -510,9 +510,9 @@
    - - - + + +
      @@ -627,12 +627,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/basics/index.html b/pir/basics/index.html index ccfe792f21..f81b269b66 100644 --- a/pir/basics/index.html +++ b/pir/basics/index.html @@ -3,30 +3,30 @@ - + Basics :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -154,9 +154,9 @@
    - - - + + +
      @@ -271,12 +271,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/basics/installation/index.html b/pir/basics/installation/index.html index f2c4f79151..4223dde2be 100644 --- a/pir/basics/installation/index.html +++ b/pir/basics/installation/index.html @@ -3,30 +3,30 @@ - + Installat'n :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -82,34 +82,34 @@

    Alternatively, ye can download th' theme as .zip file an' extract it 'n th' themes directory

    Basic configurat'n

    When build'n th' website, ye can set a theme by us'n --theme opt'n. However, we suggest ye modify th' configurat'n file (config.toml) an' set th' theme as th' default. Ye can also add th' [outputs] section t' en'ble th' search functionality.

    -
    # Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo
    -theme = "hugo-theme-relearn"
    -
    -# For search functionality
    -[outputs]
    -home = [ "HTML", "RSS", "JSON"]
    -

    Create yer first chapter plank

    +
    # Change th' default theme t' be use when build'n th' ship wit' Cap'n Hugo
    +theme = "hugo-theme-relearn"
    +
    +# For search functionality
    +[outputs]
    +home = [ "HTML", "RSS", "JSON"]
    +

    Create yer first chapter plank

    Chapters be planks that contain other child planks. It has a special layout style an' usually just contains a chapter name, th' title an' a brief abstract o' th' section.

    -
    ### Chapter 1
    -
    -# Basics
    -
    -Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.
    -

    renders as

    +
    ### Chapter 1
    +
    +# Basics
    +
    +Discover what this Cap'n Hugo theme be all about an' th' core concepts behind it.
    +

    renders as

    A Chapter

    Th' Relearrrn theme provides archetypes t' create skeletons fer yer website. Begin by creat'n yer first chapter plank wit' th' follow'n command

    -
    hugo new --kind chapter basics/_index.md
    -

    By open'n th' given file, ye should see th' property chapter=true on top, mean'n this plank be a chapter.

    +
    hugo new --kind chapter basics/_index.md
    +

    By open'n th' given file, ye should see th' property chapter=true on top, mean'n this plank be a chapter.

    By default all chapters an' planks be created as a draft. If ye want t' render these planks, remove th' property draft: true from th' metadata.

    Create yer first rrrambl'n planks

    Then, create rrrambl'n planks inside th' previously created chapter. Here be two ways t' create rrrambl'n 'n th' chapter:

    -
    hugo new basics/first-content.md
    -hugo new basics/second-content/_index.md
    -

    Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.

    +
    hugo new basics/first-content.md
    +hugo new basics/second-content/_index.md
    +

    Feel free t' edit those files by add'n some sample rrrambl'n an' replac'n th' title value 'n th' beginn'n o' th' files.

    Launch'n th' website locally

    Launch by us'n th' follow'n command:

    -
    hugo serve
    -

    Go t' http://localhost:1313

    +
    hugo serve
    +

    Go t' http://localhost:1313

    Ye should notice three th'ns:

    1. Ye have a left-side Basics menu, contain'n two submenus wit' names equal t' th' title properties 'n th' previously created files.
    2. @@ -118,8 +118,8 @@ hugo new basics/second-content/_index.md

    Build th' website

    When yer ship be ready t' deploy, run th' follow'n command:

    -
    hugo
    -

    A public folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.

    +
    hugo
    +

    A public folder will be generated, contain'n all static rrrambl'n an' assets fer yer website. It can now be deployed on any web server.

    Avast
    @@ -209,9 +209,9 @@ hugo new basics/second-content/_index.md
    - - - + + +
      @@ -326,12 +326,12 @@ hugo new basics/second-content/_index.md
    - - - - - - + + + + + + - + diff --git a/pir/basics/migration/index.html b/pir/basics/migration/index.html index 0eab83f42e..c14e728f6f 100644 --- a/pir/basics/migration/index.html +++ b/pir/basics/migration/index.html @@ -3,30 +3,30 @@ - + Migrrrat'n :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -140,8 +140,8 @@

    Also, th' old themes implementat'n allowed refs t' non-exist'n rrrambl'n. This will cause Hugos implementat'n t' show th' error below an' abort th' generat'n. If yer project relies on this old behavior, ye can reconfigure th' error handl'n o' Hugos implementat'n.

    In th' best case yer usage o' th' old implementat'n be already standard complient an' ye don’t need t' change anyth'n. You’ll notice this very easily once you’ve started hugo server aft an upgrade an' no errors be written t' th' console.

    Ye may see errors on th' console aft th' update 'n th' form:

    -
    ERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref "basics/configuration/_index.md": "hugo-theme-relearn\exampleSite\content\_index.en.md:19:22": plank not found
    -

    In this case, ye must apply one o' two opt'ns:

    +
    ERROR 2021/11/19 22:29:10 [en] REF_NOT_FOUND: Ref "basics/configuration/_index.md": "hugo-theme-relearn\exampleSite\content\_index.en.md:19:22": plank not found
    +

    In this case, ye must apply one o' two opt'ns:

    1. Copy th' old implementat'n files theme/hugo-theme-relearn/layouts/shortcode/ref.html an' theme/hugo-theme-relearn/layouts/shortcode/relref.html t' yer own projects layouts/shortcode/ref.html an' layouts/shortcode/relref.html respectively. This be not recommended as yer project will still rely on non-standard behavior afterwards.

      @@ -371,9 +371,9 @@
    - - - + + +
      @@ -488,12 +488,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/basics/requirements/index.html b/pir/basics/requirements/index.html index 8943a7b9cb..d111804d49 100644 --- a/pir/basics/requirements/index.html +++ b/pir/basics/requirements/index.html @@ -3,30 +3,30 @@ - + Requirrrements :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -156,9 +156,9 @@
    - - - + + +
      @@ -273,12 +273,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/categories/index.html b/pir/categories/index.html index 07666518ae..4853e372d0 100644 --- a/pir/categories/index.html +++ b/pir/categories/index.html @@ -3,30 +3,30 @@ - + Categories :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -138,9 +138,9 @@
    - - - + + +
      @@ -255,12 +255,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/cont/archetypes/index.html b/pir/cont/archetypes/index.html index f32ce120d1..6fe74353da 100644 --- a/pir/cont/archetypes/index.html +++ b/pir/cont/archetypes/index.html @@ -3,29 +3,29 @@ - + Arrrchetypes :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -75,33 +75,33 @@

    It be pre-configured skeleton planks wit' default front matter. Please refer t' th' documentat'n fer types o' plank t' understand th' differences.

    Chapter

    T' create a Chapter plank, run th' follow'n commands

    -
    hugo new --kind chapter <name>/_index.md
    -

    It will create a plank wit' predefined Front-Matter:

    -
    +++
    -chapter = true
    -pre = "<b>X. </b>"
    -title = "{{ replace .Name "-" " " | title }}"
    -weight = 5
    -+++
    -
    -### Chapter X
    -
    -# Some Chapter title
    -
    -Lorem Ipsum.
    -

    Default

    +
    hugo new --kind chapter <name>/_index.md
    +

    It will create a plank wit' predefined Front-Matter:

    +
    +++
    +chapter = true
    +pre = "<b>X. </b>"
    +title = "{{ replace .Name "-" " " | title }}"
    +weight = 5
    ++++
    +
    +### Chapter X
    +
    +# Some Chapter title
    +
    +Lorem Ipsum.
    +

    Default

    T' create a default plank, run either one o' th' follow'n commands either

    -
    hugo new <chapter>/<name>/_index.md
    -

    or

    -
    hugo new <chapter>/<name>.md
    -

    It will create a plank wit' predefined Front-Matter:

    -
    +++
    -title = "{{ replace .Name "-" " " | title }}"
    -weight = 5
    -+++
    -
    -Lorem Ipsum.
    -
    +
    hugo new <chapter>/<name>/_index.md
    +

    or

    +
    hugo new <chapter>/<name>.md
    +

    It will create a plank wit' predefined Front-Matter:

    +
    +++
    +title = "{{ replace .Name "-" " " | title }}"
    +weight = 5
    ++++
    +
    +Lorem Ipsum.
    +
    @@ -182,9 +182,9 @@ - - - + + +
      @@ -299,12 +299,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/cont/i18n/index.html b/pir/cont/i18n/index.html index 2a37da102f..f0d74a336f 100644 --- a/pir/cont/i18n/index.html +++ b/pir/cont/i18n/index.html @@ -3,30 +3,30 @@ - + Multilingual an' i18n :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -83,20 +83,20 @@

    Basic configurat'n

    Aft learn'n how Cap'n Hugo handle multilingual websites, define yer languages 'n yer config.toml file.

    For example wit' current English an' Piratized English website.

    -
    # English be th' default language
    -defaultContentLanguage = "en"
    -
    -[Languages]
    -[Languages.en]
    -title = "Hugo Relearrrn Theme"
    -weight = 1
    -languageName = "English"
    -
    -[Languages.pir]
    -title = "Cap'n Hugo Relearrrn Theme"
    -weight = 2
    -languageName = "Arrr! Pirrrates"
    -

    Then, fer each new plank, append th' id o' th' language t' th' file.

    +
    # English be th' default language
    +defaultContentLanguage = "en"
    +
    +[Languages]
    +[Languages.en]
    +title = "Hugo Relearrrn Theme"
    +weight = 1
    +languageName = "English"
    +
    +[Languages.pir]
    +title = "Cap'n Hugo Relearrrn Theme"
    +weight = 2
    +languageName = "Arrr! Pirrrates"
    +

    Then, fer each new plank, append th' id o' th' language t' th' file.

    • Single file my-page.md be split 'n two files:
        @@ -133,10 +133,10 @@

        Dis'ble language switch'n

        Switch'n th' language 'n th' browser be a great feature, but fer some reasons ye may want t' dis'ble it.

        Just set disableLanguageSwitchingButton=true 'n yer config.toml

        -
        [params]
        -  # When us'n mulitlingual website, dis'ble th' switch language button.
        -  disableLanguageSwitchingButton = true
        -
        +
        [params]
        +  # When us'n mulitlingual website, dis'ble th' switch language button.
        +  disableLanguageSwitchingButton = true
        +
    @@ -217,9 +217,9 @@ - - - + + +
      @@ -334,12 +334,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/cont/icons/index.html b/pir/cont/icons/index.html index 2327393de6..5fe18dceb6 100644 --- a/pir/cont/icons/index.html +++ b/pir/cont/icons/index.html @@ -3,29 +3,29 @@ - + Ay'cons an' logos :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -76,11 +76,11 @@

    Browse through th' avail'ble ay'cons 'n th' Font Awesome Gallery. Notice that th' free filter be enabled, as only th' free ay'cons be avail'ble by default.

    Once on th' Font Awesome plank fer a specific ay'con, fer example th' plank fer th' heart, copy th' HTML reference an' paste into th' Marrrkdown rrrambl'n.

    Th' HTML t' include th' heart ay'con be:

    -
    <i class="fas fa-heart"></i>
    -

    Includ'n 'n markdown

    +
    <i class="fas fa-heart"></i>
    +

    Includ'n 'n markdown

    Paste th' <i> HTML into marrrkup an' Font Awesome will board th' relevant ay'con.

    -
    Built wit' <i class="fas fa-heart"></i> by Relearrrn an' Cap'n Hugo
    -

    Which appears as

    +
    Built wit' <i class="fas fa-heart"></i> by Relearrrn an' Cap'n Hugo
    +

    Which appears as

    Built wit' by Relearrrn an' Cap'n Hugo

    Customis'n ay'cons

    Font Awesome provides many ways t' modify th' ay'con

    @@ -172,9 +172,9 @@
    - - - + + +
      @@ -289,12 +289,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/cont/index.html b/pir/cont/index.html index ec855e22ee..1f4d612d03 100644 --- a/pir/cont/index.html +++ b/pir/cont/index.html @@ -3,30 +3,30 @@ - + Rambl'n :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -154,9 +154,9 @@
    - - - + + +
      @@ -271,12 +271,12 @@
    - - - - - - + + + + + + - + diff --git a/pir/cont/markdown/index.html b/pir/cont/markdown/index.html index b7c3524b41..e89ace0666 100644 --- a/pir/cont/markdown/index.html +++ b/pir/cont/markdown/index.html @@ -3,29 +3,29 @@ - + Marrrkdown rules :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
    @@ -98,13 +98,13 @@

    Head'ns

    Head'ns from h1 through h6 be constructed wit' a # fer each level:

    -
    # h1 Head'n
    -## h2 Head'n
    -### h3 Head'n
    -#### h4 Head'n
    -##### h5 Head'n
    -###### h6 Head'n
    -

    Renders t':

    +
    # h1 Head'n
    +## h2 Head'n
    +### h3 Head'n
    +#### h4 Head'n
    +##### h5 Head'n
    +###### h6 Head'n
    +

    Renders t':

    h1 Head'n

    @@ -114,18 +114,18 @@
    h5 Head'n
    h6 Head'n

    HTML:

    -
    <h1>h1 Head'n</h1>
    -<h2>h2 Head'n</h2>
    -<h3>h3 Head'n</h3>
    -<h4>h4 Head'n</h4>
    -<h5>h5 Head'n</h5>
    -<h6>h6 Head'n</h6>
    -

    Comments

    +
    <h1>h1 Head'n</h1>
    +<h2>h2 Head'n</h2>
    +<h3>h3 Head'n</h3>
    +<h4>h4 Head'n</h4>
    +<h5>h5 Head'n</h5>
    +<h6>h6 Head'n</h6>
    +

    Comments

    Comments should be HTML compat'ble

    -
    <!--
    -This be a comment
    --->
    -

    Comment below should NOT be seen:

    +
    <!--
    +This be a comment
    +-->
    +

    Comment below should NOT be seen:

    @@ -136,56 +136,56 @@ This be a comment

    Paragraphs

    Any text not start'n wit' a special sign be written as normal, plain text an' will be wrapped within <p></p> tags 'n th' rendered HTML.

    So this body copy:

    -
    Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. 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.
    -

    renders t' this HTML:

    -
    <p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. 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>
    -

    Text Markers

    +
    Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. 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.
    +

    renders t' this HTML:

    +
    <p>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. 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>
    +

    Text Markers

    Bold

    For emphasiz'n a snippet o' text wit' a heavier font-weight.

    Th' follow'n snippet o' text be rendered as bold text.

    -
    **rendered as bold text**
    -

    renders t':

    +
    **rendered as bold text**
    +

    renders t':

    rendered as bold text

    an' this HTML

    -
    <strong>rendered as bold text</strong>
    -

    Italics

    +
    <strong>rendered as bold text</strong>
    +

    Italics

    For emphasiz'n a snippet o' text wit' italics.

    Th' follow'n snippet o' text be rendered as italicized text.

    -
    _rendered as italicized text_
    -

    renders t':

    +
    _rendered as italicized text_
    +

    renders t':

    rendered as italicized text

    an' this HTML:

    -
    <em>rendered as italicized text</em>
    -

    Strikethrough

    +
    <em>rendered as italicized text</em>
    +

    Strikethrough

    In GFM (GitHub flavored Markdown) ye can do strikethroughs.

    -
    ~~Strike through this text.~~
    -

    Which renders t':

    +
    ~~Strike through this text.~~
    +

    Which renders t':

    Strike through this text.

    HTML:

    -
    <del>Strike through this text.</del>
    -

    Blockquotes

    +
    <del>Strike through this text.</del>
    +

    Blockquotes

    For quot'n blocks o' rrrambl'n from another source within yer document.

    Add > before any text ye want t' quote.

    -
    > **Fusion Drive** combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.
    -

    Renders t':

    +
    > **Fusion Drive** combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.
    +

    Renders t':

    Fusion Drive combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.

    an' this HTML:

    -
    <blockquote>
    -  <p><strong>Fusion Drive</strong> combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.</p>
    -</blockquote>
    -

    Blockquotes can also be nested:

    -
    > Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
    ->
    -> > Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.
    ->
    -> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
    -

    Renders t':

    +
    <blockquote>
    +  <p><strong>Fusion Drive</strong> combines a hard drive wit' a flash storage (solid-state drive) an' presents it as a single logical volume wit' th' space o' both drives combined.</p>
    +</blockquote>
    +

    Blockquotes can also be nested:

    +
    > Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
    +>
    +> > Sed adipisc'n elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis 'n dolor tincidunt mollis ac eu diam.
    +>
    +> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
    +

    Renders t':

    Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.

    @@ -197,23 +197,23 @@ This be a comment

    Unordered

    A list o' items 'n which th' order o' th' items does not explicitly matter.

    Ye may use any o' th' follow'n symbols t' denote bullets fer each list item:

    -
    * valid bullet
    -- valid bullet
    -+ valid bullet
    -

    For example

    -
    + Lorem ipsum dolor sit amet
    -+ Consectetur adipisc'n elit
    -+ Integer molestie lorem at massa
    -+ Facilisis 'n pretium nisl aliquet
    -+ Nulla volutpat aliquam velit
    -  - Phasellus iaculis neque
    -  - Purus sodales ultricies
    -  - Vestibulum laoreet porttitor sem
    -  - Ac tristique libero volutpat at
    -+ Faucibus porta lacus fringilla vel
    -+ Aenean sit amet erat nunc
    -+ Eget porttitor lorem
    -

    Renders t':

    +
    * valid bullet
    +- valid bullet
    ++ valid bullet
    +

    For example

    +
    + Lorem ipsum dolor sit amet
    ++ Consectetur adipisc'n elit
    ++ Integer molestie lorem at massa
    ++ Facilisis 'n pretium nisl aliquet
    ++ Nulla volutpat aliquam velit
    +  - Phasellus iaculis neque
    +  - Purus sodales ultricies
    +  - Vestibulum laoreet porttitor sem
    +  - Ac tristique libero volutpat at
    ++ Faucibus porta lacus fringilla vel
    ++ Aenean sit amet erat nunc
    ++ Eget porttitor lorem
    +

    Renders t':

    • Lorem ipsum dolor sit amet
    • @@ -234,34 +234,34 @@ This be a comment

    An' this HTML

    -
    <ul>
    -  <li>Lorem ipsum dolor sit amet</li>
    -  <li>Consectetur adipisc'n elit</li>
    -  <li>Integer molestie lorem at massa</li>
    -  <li>Facilisis 'n pretium nisl aliquet</li>
    -  <li>Nulla volutpat aliquam velit
    -    <ul>
    -      <li>Phasellus iaculis neque</li>
    -      <li>Purus sodales ultricies</li>
    -      <li>Vestibulum laoreet porttitor sem</li>
    -      <li>Ac tristique libero volutpat at</li>
    -    </ul>
    -  </li>
    -  <li>Faucibus porta lacus fringilla vel</li>
    -  <li>Aenean sit amet erat nunc</li>
    -  <li>Eget porttitor lorem</li>
    -</ul>
    -

    Ordered

    +
    <ul>
    +  <li>Lorem ipsum dolor sit amet</li>
    +  <li>Consectetur adipisc'n elit</li>
    +  <li>Integer molestie lorem at massa</li>
    +  <li>Facilisis 'n pretium nisl aliquet</li>
    +  <li>Nulla volutpat aliquam velit
    +    <ul>
    +      <li>Phasellus iaculis neque</li>
    +      <li>Purus sodales ultricies</li>
    +      <li>Vestibulum laoreet porttitor sem</li>
    +      <li>Ac tristique libero volutpat at</li>
    +    </ul>
    +  </li>
    +  <li>Faucibus porta lacus fringilla vel</li>
    +  <li>Aenean sit amet erat nunc</li>
    +  <li>Eget porttitor lorem</li>
    +</ul>
    +

    Ordered

    A list o' items 'n which th' order o' items does explicitly matter.

    -
    1. Lorem ipsum dolor sit amet
    -4. Consectetur adipisc'n elit
    -2. Integer molestie lorem at massa
    -8. Facilisis 'n pretium nisl aliquet
    -4. Nulla volutpat aliquam velit
    -99. Faucibus porta lacus fringilla vel
    -21. Aenean sit amet erat nunc
    -6. Eget porttitor lorem
    -

    Renders t':

    +
    1. Lorem ipsum dolor sit amet
    +4. Consectetur adipisc'n elit
    +2. Integer molestie lorem at massa
    +8. Facilisis 'n pretium nisl aliquet
    +4. Nulla volutpat aliquam velit
    +99. Faucibus porta lacus fringilla vel
    +21. Aenean sit amet erat nunc
    +6. Eget porttitor lorem
    +

    Renders t':

    1. Lorem ipsum dolor sit amet
    2. Consectetur adipisc'n elit
    3. @@ -273,17 +273,17 @@ This be a comment
    4. Eget porttitor lorem

    An' this HTML:

    -
    <ol>
    -  <li>Lorem ipsum dolor sit amet</li>
    -  <li>Consectetur adipisc'n elit</li>
    -  <li>Integer molestie lorem at massa</li>
    -  <li>Facilisis 'n pretium nisl aliquet</li>
    -  <li>Nulla volutpat aliquam velit</li>
    -  <li>Faucibus porta lacus fringilla vel</li>
    -  <li>Aenean sit amet erat nunc</li>
    -  <li>Eget porttitor lorem</li>
    -</ol>
    -
    +
    <ol>
    +  <li>Lorem ipsum dolor sit amet</li>
    +  <li>Consectetur adipisc'n elit</li>
    +  <li>Integer molestie lorem at massa</li>
    +  <li>Facilisis 'n pretium nisl aliquet</li>
    +  <li>Nulla volutpat aliquam velit</li>
    +  <li>Faucibus porta lacus fringilla vel</li>
    +  <li>Aenean sit amet erat nunc</li>
    +  <li>Eget porttitor lorem</li>
    +</ol>
    +
    Smarrrt Arrrse
    @@ -291,15 +291,15 @@ This be a comment
    -
    1. Lorem ipsum dolor sit amet
    -1. Consectetur adipisc'n elit
    -1. Integer molestie lorem at massa
    -1. Facilisis 'n pretium nisl aliquet
    -1. Nulla volutpat aliquam velit
    -1. Faucibus porta lacus fringilla vel
    -1. Aenean sit amet erat nunc
    -1. Eget porttitor lorem
    -

    Renders t':

    +
    1. Lorem ipsum dolor sit amet
    +1. Consectetur adipisc'n elit
    +1. Integer molestie lorem at massa
    +1. Facilisis 'n pretium nisl aliquet
    +1. Nulla volutpat aliquam velit
    +1. Faucibus porta lacus fringilla vel
    +1. Aenean sit amet erat nunc
    +1. Eget porttitor lorem
    +

    Renders t':

    1. Lorem ipsum dolor sit amet
    2. Consectetur adipisc'n elit
    3. @@ -313,18 +313,18 @@ This be a comment

      Code

      Inline code

      Wrap inline snippets o' code wit' `.

      -
      In this example, `<div></div>` should be wrapped as **code**.
      -

      Renders t':

      +
      In this example, `<div></div>` should be wrapped as **code**.
      +

      Renders t':

      In this example, <div></div> should be wrapped as code.

      HTML:

      -
      <p>In this example, <code>&lt;div&gt;&lt;/div&gt;</code> should be wrapped as <strong>code</strong>.</p>
      -

      Indented code

      +
      <p>In this example, <code>&lt;div&gt;&lt;/div&gt;</code> should be wrapped as <strong>code</strong>.</p>
      +

      Indented code

      Or indent several lines o' code by at least two spaces, as 'n:

      -
          // Some comments
      -    line 1 o' code
      -    line 2 o' code
      -    line 3 o' code
      -

      Renders t':

      +
          // Some comments
      +    line 1 o' code
      +    line 2 o' code
      +    line 3 o' code
      +

      Renders t':

      // Some comments
       line 1 o' code
      @@ -333,74 +333,74 @@ line 3 o' code
       

      HTML:

      -
      <pre>
      -  <code>
      -    // Some comments
      -    line 1 o' code
      -    line 2 o' code
      -    line 3 o' code
      -  </code>
      -</pre>
      -

      Block code “fences”

      +
      <pre>
      +  <code>
      +    // Some comments
      +    line 1 o' code
      +    line 2 o' code
      +    line 3 o' code
      +  </code>
      +</pre>
      +

      Block code “fences”

      Use “fences” ``` t' block 'n multiple lines o' code.

      -
      ```
      -Sample text here...
      -```
      -

      HTML:

      -
      <pre>
      -  <code>Sample text here...</code>
      -</pre>
      -

      Rules highlight'n

      +
      ```
      +Sample text here...
      +```
      +

      HTML:

      +
      <pre>
      +  <code>Sample text here...</code>
      +</pre>
      +

      Rules highlight'n

      GFM, or “GitHub Flavored Markdown” also supports rules highlight'n. T' activate it, usually ye simply add th' file extension o' th' language ye want t' use directly aft th' first code “fence”, ```js, an' rules highlight'n will automatically be applied 'n th' rendered HTML.

      See Code Highlight'n fer additional documentat'n.

      For example, t' apply rules highlight'n t' JavaScript code:

      -
      ```js
      -grunt.initConfig({
      -  assemble: {
      -    opt'ns: {
      -      assets: 'docs/assets',
      -      data: 'src/data/*.{json,yml}',
      -      helpers: 'src/custom-helpers.js',
      -      partials: ['src/partials/**/*.{hbs,md}']
      -    },
      -    planks: {
      -      opt'ns: {
      -        layout: 'default.hbs'
      -      },
      -      files: {
      -        './': ['src/templates/pages/index.hbs']
      -      }
      -    }
      -  }
      -};
      -```
      -

      Renders t':

      -
      grunt.initConfig({
      -  assemble: {
      -    opt'ns: {
      -      assets: 'docs/assets',
      -      data: 'src/data/*.{json,yml}',
      -      helpers: 'src/custom-helpers.js',
      -      partials: ['src/partials/**/*.{hbs,md}']
      -    },
      -    planks: {
      -      opt'ns: {
      -        layout: 'default.hbs'
      -      },
      -      files: {
      -        './': ['src/templates/pages/index.hbs']
      -      }
      -    }
      -  }
      -};
      -

      Tables

      +
      ```js
      +grunt.initConfig({
      +  assemble: {
      +    opt'ns: {
      +      assets: 'docs/assets',
      +      data: 'src/data/*.{json,yml}',
      +      helpers: 'src/custom-helpers.js',
      +      partials: ['src/partials/**/*.{hbs,md}']
      +    },
      +    planks: {
      +      opt'ns: {
      +        layout: 'default.hbs'
      +      },
      +      files: {
      +        './': ['src/templates/pages/index.hbs']
      +      }
      +    }
      +  }
      +};
      +```
      +

      Renders t':

      +
      grunt.initConfig({
      +  assemble: {
      +    opt'ns: {
      +      assets: 'docs/assets',
      +      data: 'src/data/*.{json,yml}',
      +      helpers: 'src/custom-helpers.js',
      +      partials: ['src/partials/**/*.{hbs,md}']
      +    },
      +    planks: {
      +      opt'ns: {
      +        layout: 'default.hbs'
      +      },
      +      files: {
      +        './': ['src/templates/pages/index.hbs']
      +      }
      +    }
      +  }
      +};
      +

      Tables

      Tables be created by add'n pipes as dividers between each cell, an' by add'n a line o' dashes (also separated by bars) beneath th' header. Avast that th' pipes do not need t' be vertically aligned.

      -
      | Opt'n | Descript'n |
      -| ------ | ----------- |
      -| data   | path t' data files t' supply th' data that will be passed into templates. |
      -| engine | engine t' be used fer process'n templates. Handlebars be th' default. |
      -| ext    | extension t' be used fer dest files. |
      -

      Renders t':

      +
      | Opt'n | Descript'n |
      +| ------ | ----------- |
      +| data   | path t' data files t' supply th' data that will be passed into templates. |
      +| engine | engine t' be used fer process'n templates. Handlebars be th' default. |
      +| ext    | extension t' be used fer dest files. |
      +

      Renders t':

      @@ -424,32 +424,32 @@ grunt.initConfig({

      An' this HTML:

      -
      <t'ble>
      -  <tr>
      -    <th>Opt'n</th>
      -    <th>Descript'n</th>
      -  </tr>
      -  <tr>
      -    <td>data</td>
      -    <td>path t' data files t' supply th' data that will be passed into templates.</td>
      -  </tr>
      -  <tr>
      -    <td>engine</td>
      -    <td>engine t' be used fer process'n templates. Handlebars be th' default.</td>
      -  </tr>
      -  <tr>
      -    <td>ext</td>
      -    <td>extension t' be used fer dest files.</td>
      -  </tr>
      -</t'ble>
      -

      Right aligned text

      +
      <t'ble>
      +  <tr>
      +    <th>Opt'n</th>
      +    <th>Descript'n</th>
      +  </tr>
      +  <tr>
      +    <td>data</td>
      +    <td>path t' data files t' supply th' data that will be passed into templates.</td>
      +  </tr>
      +  <tr>
      +    <td>engine</td>
      +    <td>engine t' be used fer process'n templates. Handlebars be th' default.</td>
      +  </tr>
      +  <tr>
      +    <td>ext</td>
      +    <td>extension t' be used fer dest files.</td>
      +  </tr>
      +</t'ble>
      +

      Right aligned text

      Add'n a colon on th' right side o' th' dashes below any head'n will right align text fer that column.

      -
      | Opt'n | Descript'n |
      -| ------:| -----------:|
      -| data   | path t' data files t' supply th' data that will be passed into templates. |
      -| engine | engine t' be used fer process'n templates. Handlebars be th' default. |
      -| ext    | extension t' be used fer dest files. |
      -
      +
      | Opt'n | Descript'n |
      +| ------:| -----------:|
      +| data   | path t' data files t' supply th' data that will be passed into templates. |
      +| engine | engine t' be used fer process'n templates. Handlebars be th' default. |
      +| ext    | extension t' be used fer dest files. |
      +
      @@ -502,44 +502,44 @@ grunt.initConfig({
      Opt'n
      -
      [Assemble](http://assemble.io)
      -

      Renders t' (hover over th' link, there be no tooltip):

      +
      [Assemble](http://assemble.io)
      +

      Renders t' (hover over th' link, there be no tooltip):

      Assemble

      HTML:

      -
      <a href="http://assemble.io">Assemble</a>
      -

      Add a tooltip

      -
      [Upstage](https://github.com/upstage/ "Visit Upstage!")
      -

      Renders t' (hover over th' link, there should be a tooltip):

      +
      <a href="http://assemble.io">Assemble</a>
      +

      Add a tooltip

      +
      [Upstage](https://github.com/upstage/ "Visit Upstage!")
      +

      Renders t' (hover over th' link, there should be a tooltip):

      Upstage

      HTML:

      -
      <a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
      -

      Named Anchors

      +
      <a href="https://github.com/upstage/" title="Visit Upstage!">Upstage</a>
      +

      Named Anchors

      Named anchors en'ble ye t' jump t' th' specified anchor point on th' same plank. For example, each o' these chapters:

      -
      # T'ble o' Contents
      -  * [Chapter 1](#chapter-1)
      -  * [Chapter 2](#chapter-2)
      -  * [Chapter 3](#chapter-3)
      -

      will jump t' these sections:

      -
      ## Chapter 1 <a id="chapter-1"></a>
      -Rrrambl'n fer chapter one.
      -
      -## Chapter 2 <a id="chapter-2"></a>
      -Rrrambl'n fer chapter one.
      -
      -## Chapter 3 <a id="chapter-3"></a>
      -Rrrambl'n fer chapter one.
      -

      NOTE that specific placement o' th' anchor tag seems t' be arbitrary. They be placed inline here since it seems t' be unobtrusive, an' it works.

      +
      # T'ble o' Contents
      +  * [Chapter 1](#chapter-1)
      +  * [Chapter 2](#chapter-2)
      +  * [Chapter 3](#chapter-3)
      +

      will jump t' these sections:

      +
      ## Chapter 1 <a id="chapter-1"></a>
      +Rrrambl'n fer chapter one.
      +
      +## Chapter 2 <a id="chapter-2"></a>
      +Rrrambl'n fer chapter one.
      +
      +## Chapter 3 <a id="chapter-3"></a>
      +Rrrambl'n fer chapter one.
      +

      NOTE that specific placement o' th' anchor tag seems t' be arbitrary. They be placed inline here since it seems t' be unobtrusive, an' it works.

      Images

      Images have a similar rules t' links but include a preced'n exclamat'n point.

      -
      ![Minion](https://octodex.github.com/images/minion.png)
      -

      Minion

      +
      ![Minion](https://octodex.github.com/images/minion.png)
      +

      Minion

      or

      -
      ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
      -

      Alt text

      +
      ![Alt text](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
      +

      Alt text

      Like links, Images also have a footnote style rules

      Alternative usage : note images

      -
      ![Alt text][id]
      -

      Alt text

      +
      ![Alt text][id]
      +

      Alt text

      Wit' a reference later 'n th' document defin'n th' URL locat'n:

      [id]: https://octodex.github.com/images/dojocat.jpg  "The Dojocat"
       
      @@ -547,25 +547,25 @@ grunt.initConfig({

      Th' Cap'n Hugo Marrrkdown parser supports additional non-standard functionality.

      Resiz'n image

      Add HTTP parameters width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).

      -
      ![Minion](https://octodex.github.com/images/minion.png?width=20pc)
      -

      Minion

      +
      ![Minion](https://octodex.github.com/images/minion.png?width=20pc)
      +

      Minion

      stormtroopocat

      -
      ![Minion](https://octodex.github.com/images/minion.png?height=50px)
      -

      Minion

      -
      ![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)
      -

      Minion

      +
      ![Minion](https://octodex.github.com/images/minion.png?height=50px)
      +

      Minion

      +
      ![Minion](https://octodex.github.com/images/minion.png?height=50px&width=300px)
      +

      Minion

      Add CSS classes

      Add a HTTP classes parameter t' th' link image t' add CSS classes. shadowan' border be avail'ble but ye could define other ones.

      -
      ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow)
      -

      stormtroopocat

      -
      ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border)
      -

      stormtroopocat

      -
      ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow)
      -

      stormtroopocat

      +
      ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow)
      +

      stormtroopocat

      +
      ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border)
      +

      stormtroopocat

      +
      ![stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow)
      +

      stormtroopocat

      Add a HTTP featherlight parameter t' th' link image t' dis'ble lightbox. By default lightbox be enabled us'n th' featherlight.js plugin. Ye can dis'ble this by defin'n featherlight t' false.

      -
      ![Minion](https://octodex.github.com/images/minion.png?featherlight=false)
      -

      Minion

      +
      ![Minion](https://octodex.github.com/images/minion.png?featherlight=false)
      +

      Minion

      @@ -647,9 +647,9 @@ grunt.initConfig({ - - - + + +
        @@ -764,12 +764,12 @@ grunt.initConfig({
      - - - - - - + + + + + + - + diff --git a/pir/cont/menushortcuts/index.html b/pir/cont/menushortcuts/index.html index 373543b22e..a3103fd3dd 100644 --- a/pir/cont/menushortcuts/index.html +++ b/pir/cont/menushortcuts/index.html @@ -3,29 +3,29 @@ - + Menu extrrra shorrrtcuts :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -75,110 +75,110 @@

      Basic configurat'n

      Edit th' website configurat'n config.toml an' add a [[menu.shortcuts]] entry fer each link yer want t' add.

      Example from th' current website:

      -
      [[menu.shortcuts]]
      -name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
      -identifier = "ds"
      -url = "https://github.com/McShelby/hugo-theme-relearn"
      -weight = 10
      -
      -[[menu.shortcuts]]
      -name = "<i class='fas fa-fw fa-camera'></i> Showcases"
      -url = "more/showcase/"
      -weight = 11
      -
      -[[menu.shortcuts]]
      -name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentation"
      -identifier = "hugodoc"
      -url = "https://gohugo.io/"
      -weight = 20
      -
      -[[menu.shortcuts]]
      -name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
      -url = "more/credits/"
      -weight = 30
      -
      -[[menu.shortcuts]]
      -name = "<i class='fas fa-fw fa-tags'></i> Tags"
      -url = "tags/"
      -weight = 40
      -

      By default, shortcuts be preceded by a title. This title can be disabled by sett'n disableShortcutsTitle=true. +

      [[menu.shortcuts]]
      +name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
      +identifier = "ds"
      +url = "https://github.com/McShelby/hugo-theme-relearn"
      +weight = 10
      +
      +[[menu.shortcuts]]
      +name = "<i class='fas fa-fw fa-camera'></i> Showcases"
      +url = "more/showcase/"
      +weight = 11
      +
      +[[menu.shortcuts]]
      +name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentation"
      +identifier = "hugodoc"
      +url = "https://gohugo.io/"
      +weight = 20
      +
      +[[menu.shortcuts]]
      +name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
      +url = "more/credits/"
      +weight = 30
      +
      +[[menu.shortcuts]]
      +name = "<i class='fas fa-fw fa-tags'></i> Tags"
      +url = "tags/"
      +weight = 40
      +

      By default, shortcuts be preceded by a title. This title can be disabled by sett'n disableShortcutsTitle=true. However, if ye want t' keep th' title but change its value, it can be overriden by chang'n yer local i18n translat'n str'n configurat'n.

      For example, 'n yer local i18n/en.toml file, add th' follow'n rrrambl'n

      -
      [Shortcuts-Title]
      -other = "<Your value>"
      -

      Read more about hugo menu an' hugo i18n translat'n str'ns

      +
      [Shortcuts-Title]
      +other = "<Your value>"
      +

      Read more about hugo menu an' hugo i18n translat'n str'ns

      Configurat'n fer Multilingual mode

      When us'n a multilingual website, ye can set different menus fer each language. In th' config.toml file, prefix yer menu configurat'n by Languages.<language-id>.

      Example from th' current website:

      -
      [Languages]
      -  [Languages.en]
      -    title = "Hugo Relearrrn Theme"
      -    weight = 1
      -    languageName = "English"
      -    landingPageURL = "/"
      -    landingPageName = "<i class='fas fa-home'></i> Home"
      -
      -  [[Languages.en.menu.shortcuts]]
      -    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
      -    identifier = "ds"
      -    url = "https://github.com/McShelby/hugo-theme-relearn"
      -    weight = 10
      -
      -  [[Languages.en.menu.shortcuts]]
      -    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
      -    url = "more/showcase/"
      -    weight = 11
      -
      -  [[Languages.en.menu.shortcuts]]
      -    name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentation"
      -    identifier = "hugodoc"
      -    url = "https://gohugo.io/"
      -    weight = 20
      -
      -  [[Languages.en.menu.shortcuts]]
      -    name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
      -    url = "more/credits/"
      -    weight = 30
      -
      -  [[Languages.en.menu.shortcuts]]
      -    name = "<i class='fas fa-fw fa-tags'></i> Tags"
      -    url = "tags/"
      -    weight = 40
      -
      -  [Languages.pir]
      -    title = "Cap'n Hugo Relearrrn Theme"
      -    weight = 1
      -    languageName = "Arrr! Pirrrates"
      -    landingPageURL = "/pir/"
      -    landingPageName = "<i class='fas fa-home'></i> Arrr! Home"
      -
      -  [[Languages.pir.menu.shortcuts]]
      -    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
      -    identifier = "ds"
      -    url = "https://github.com/McShelby/hugo-theme-relearn"
      -    weight = 10
      -
      -  [[Languages.pir.menu.shortcuts]]
      -    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
      -    url = "more/showcase/"
      -    weight = 11
      -
      -  [[Languages.pir.menu.shortcuts]]
      -    name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentat'n"
      -    identifier = "hugodoc"
      -    url = "https://gohugo.io/"
      -    weight = 20
      -
      -  [[Languages.pir.menu.shortcuts]]
      -    name = "<i class='fas fa-fw fa-bullhorn'></i> Crrredits"
      -    url = "more/credits/"
      -    weight = 30
      -
      -  [[Languages.pir.menu.shortcuts]]
      -    name = "<i class='fas fa-fw fa-tags'></i> Arrr! Tags"
      -    url = "tags/"
      -    weight = 40
      -

      Read more about hugo menu an' hugo multilingual menus

      +
      [Languages]
      +  [Languages.en]
      +    title = "Hugo Relearrrn Theme"
      +    weight = 1
      +    languageName = "English"
      +    landingPageURL = "/"
      +    landingPageName = "<i class='fas fa-home'></i> Home"
      +
      +  [[Languages.en.menu.shortcuts]]
      +    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
      +    identifier = "ds"
      +    url = "https://github.com/McShelby/hugo-theme-relearn"
      +    weight = 10
      +
      +  [[Languages.en.menu.shortcuts]]
      +    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
      +    url = "more/showcase/"
      +    weight = 11
      +
      +  [[Languages.en.menu.shortcuts]]
      +    name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentation"
      +    identifier = "hugodoc"
      +    url = "https://gohugo.io/"
      +    weight = 20
      +
      +  [[Languages.en.menu.shortcuts]]
      +    name = "<i class='fas fa-fw fa-bullhorn'></i> Credits"
      +    url = "more/credits/"
      +    weight = 30
      +
      +  [[Languages.en.menu.shortcuts]]
      +    name = "<i class='fas fa-fw fa-tags'></i> Tags"
      +    url = "tags/"
      +    weight = 40
      +
      +  [Languages.pir]
      +    title = "Cap'n Hugo Relearrrn Theme"
      +    weight = 1
      +    languageName = "Arrr! Pirrrates"
      +    landingPageURL = "/pir/"
      +    landingPageName = "<i class='fas fa-home'></i> Arrr! Home"
      +
      +  [[Languages.pir.menu.shortcuts]]
      +    name = "<i class='fab fa-fw fa-github'></i> GitHub repo"
      +    identifier = "ds"
      +    url = "https://github.com/McShelby/hugo-theme-relearn"
      +    weight = 10
      +
      +  [[Languages.pir.menu.shortcuts]]
      +    name = "<i class='fas fa-fw fa-camera'></i> Showcases"
      +    url = "more/showcase/"
      +    weight = 11
      +
      +  [[Languages.pir.menu.shortcuts]]
      +    name = "<i class='fas fa-fw fa-bookmark'></i> Cap'n Hugo Documentat'n"
      +    identifier = "hugodoc"
      +    url = "https://gohugo.io/"
      +    weight = 20
      +
      +  [[Languages.pir.menu.shortcuts]]
      +    name = "<i class='fas fa-fw fa-bullhorn'></i> Crrredits"
      +    url = "more/credits/"
      +    weight = 30
      +
      +  [[Languages.pir.menu.shortcuts]]
      +    name = "<i class='fas fa-fw fa-tags'></i> Arrr! Tags"
      +    url = "tags/"
      +    weight = 40
      +

      Read more about hugo menu an' hugo multilingual menus

      @@ -260,9 +260,9 @@ However, if ye want t' keep th' title but change its value, it can be overriden
      - - - + + +
        @@ -377,12 +377,12 @@ However, if ye want t' keep th' title but change its value, it can be overriden
      - - - - - - + + + + + + - + diff --git a/pir/cont/pages/index.html b/pir/cont/pages/index.html index f573270380..18d0d60931 100644 --- a/pir/cont/pages/index.html +++ b/pir/cont/pages/index.html @@ -3,30 +3,30 @@ - + Planks orrrganizat'n :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -75,30 +75,30 @@

      In Cap'n Hugo, planks be th' core o' yer ship. Once it be configured, planks be definitely th' added value t' yer documentat'n ship.

      Folders

      Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rrrambl'n folder wit' all yer planks.

      -
      rrrambl'n
      -├── level-one
      -│   ├── level-two
      -│   │   ├── level-three
      -│   │   │   ├── level-four
      -│   │   │   │   ├── _index.md       <-- /level-one/level-two/level-three/level-four
      -│   │   │   │   ├── page-4-a.md     <-- /level-one/level-two/level-three/level-four/page-4-a
      -│   │   │   │   ├── page-4-b.md     <-- /level-one/level-two/level-three/level-four/page-4-b
      -│   │   │   │   └── page-4-c.md     <-- /level-one/level-two/level-three/level-four/page-4-c
      -│   │   │   ├── _index.md           <-- /level-one/level-two/level-three
      -│   │   │   ├── page-3-a.md         <-- /level-one/level-two/level-three/page-3-a
      -│   │   │   ├── page-3-b.md         <-- /level-one/level-two/level-three/page-3-b
      -│   │   │   └── page-3-c.md         <-- /level-one/level-two/level-three/page-3-c
      -│   │   ├── _index.md               <-- /level-one/level-two
      -│   │   ├── page-2-a.md             <-- /level-one/level-two/page-2-a
      -│   │   ├── page-2-b.md             <-- /level-one/level-two/page-2-b
      -│   │   └── page-2-c.md             <-- /level-one/level-two/page-2-c
      -│   ├── _index.md                   <-- /level-one
      -│   ├── page-1-a.md                 <-- /level-one/page-1-a
      -│   ├── page-1-b.md                 <-- /level-one/page-1-b
      -│   └── page-1-c.md                 <-- /level-one/page-1-c
      -├── _index.md                       <-- /
      -└── page-top.md                     <-- /page-top
      -
      +
      rrrambl'n
      +├── level-one
      +│   ├── level-two
      +│   │   ├── level-three
      +│   │   │   ├── level-four
      +│   │   │   │   ├── _index.md       <-- /level-one/level-two/level-three/level-four
      +│   │   │   │   ├── page-4-a.md     <-- /level-one/level-two/level-three/level-four/page-4-a
      +│   │   │   │   ├── page-4-b.md     <-- /level-one/level-two/level-three/level-four/page-4-b
      +│   │   │   │   └── page-4-c.md     <-- /level-one/level-two/level-three/level-four/page-4-c
      +│   │   │   ├── _index.md           <-- /level-one/level-two/level-three
      +│   │   │   ├── page-3-a.md         <-- /level-one/level-two/level-three/page-3-a
      +│   │   │   ├── page-3-b.md         <-- /level-one/level-two/level-three/page-3-b
      +│   │   │   └── page-3-c.md         <-- /level-one/level-two/level-three/page-3-c
      +│   │   ├── _index.md               <-- /level-one/level-two
      +│   │   ├── page-2-a.md             <-- /level-one/level-two/page-2-a
      +│   │   ├── page-2-b.md             <-- /level-one/level-two/page-2-b
      +│   │   └── page-2-c.md             <-- /level-one/level-two/page-2-c
      +│   ├── _index.md                   <-- /level-one
      +│   ├── page-1-a.md                 <-- /level-one/page-1-a
      +│   ├── page-1-b.md                 <-- /level-one/page-1-b
      +│   └── page-1-c.md                 <-- /level-one/page-1-c
      +├── _index.md                       <-- /
      +└── page-top.md                     <-- /page-top
      +
      Avast
      @@ -112,81 +112,81 @@

      A Chapter displays a plank meant t' be used as introduct'n fer a set o' child planks. Commonly, it contains a simple title an' a catch line t' define rrrambl'n that can be found under it.

      Ye can define any HTML as prefix fer th' menu. In th' example below, it’s just a number but that could be an ay'con.

      Chapter page

      -
      +++
      -chapter = true
      -pre = "<b>1. </b>"
      -title = "Basics"
      -weight = 5
      -+++
      -
      -### Chapter 1
      -
      -# Basics
      -
      -Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.
      -

      T' tell th' Relearrrn theme t' consider a plank as a chapter, set chapter=true 'n th' Front Matter o' th' plank.

      +
      +++
      +chapter = true
      +pre = "<b>1. </b>"
      +title = "Basics"
      +weight = 5
      ++++
      +
      +### Chapter 1
      +
      +# Basics
      +
      +Discover what this Cap'n Hugo theme be all about an' th' core-concepts behind it.
      +

      T' tell th' Relearrrn theme t' consider a plank as a chapter, set chapter=true 'n th' Front Matter o' th' plank.

      Default

      A Default plank be any other rrrambl'n plank.

      Default page

      -
      +++
      -title = "Installation"
      -weight = 15
      -+++
      -

      Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n this great documentat'n fer beginners.

      +
      +++
      +title = "Installation"
      +weight = 15
      ++++
      +

      Th' follow'n steps be here t' help ye initialize yer new website. If ye don’t know Cap'n Hugo at all, we strongly suggest ye t' train by follow'n this great documentat'n fer beginners.

      Create yer project

      Cap'n Hugo provides a new command t' create a new website.

      -
      hugo new ship <new_project>
      -

      Th' Relearrrn theme provides archetypes t' help ye create this kind o' planks.

      +
      hugo new ship <new_project>
      +

      Th' Relearrrn theme provides archetypes t' help ye create this kind o' planks.

      Front Matter configurat'n

      Each Cap'n Hugo plank has t' define a Front Matter 'n toml, yaml or json. This ship will use toml 'n all cases.

      Th' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones :

      -
      +++
      -# T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it.
      -# Avast: Toc be always disabled fer chapter planks
      -disableToc = false
      -# If set, this will be used fer th' page's menu entry (instead o' th' `title` attribute)
      -menuTitle = ""
      -# If set, this will explicitly override common rules fer th' expand state o' a page's menu entry
      -alwaysopen = true
      -# If set, this will explicitly override common rules fer th' sort'n order o' a page's submenu entries
      -ordersectionsby = "title"
      -# Th' title o' th' plank 'n menu will be prefixed by this HTML rrrambl'n
      -pre = ""
      -# Th' title o' th' plank 'n menu will be postfixed by this HTML rrrambl'n
      -post = ""
      -# Set th' plank as a chapter, chang'n th' way it's displayed
      -chapter = false
      -# Hide a menu entry by sett'n this t' true
      -hidden = false
      -# Display name o' this plank modifier. If set, it will be displayed 'n th' footer.
      -LastModifierDisplayName = ""
      -# Email o' this plank modifier. If set wit' LastModifierDisplayName, it will be displayed 'n th' footer
      -LastModifierEmail = ""
      -+++
      -

      Add ay'con t' a menu entry

      +
      +++
      +# T'ble o' contents (toc) be enabled by default. Set this parameter t' true t' dis'ble it.
      +# Avast: Toc be always disabled fer chapter planks
      +disableToc = false
      +# If set, this will be used fer th' page's menu entry (instead o' th' `title` attribute)
      +menuTitle = ""
      +# If set, this will explicitly override common rules fer th' expand state o' a page's menu entry
      +alwaysopen = true
      +# If set, this will explicitly override common rules fer th' sort'n order o' a page's submenu entries
      +ordersectionsby = "title"
      +# Th' title o' th' plank 'n menu will be prefixed by this HTML rrrambl'n
      +pre = ""
      +# Th' title o' th' plank 'n menu will be postfixed by this HTML rrrambl'n
      +post = ""
      +# Set th' plank as a chapter, chang'n th' way it's displayed
      +chapter = false
      +# Hide a menu entry by sett'n this t' true
      +hidden = false
      +# Display name o' this plank modifier. If set, it will be displayed 'n th' footer.
      +LastModifierDisplayName = ""
      +# Email o' this plank modifier. If set wit' LastModifierDisplayName, it will be displayed 'n th' footer
      +LastModifierEmail = ""
      ++++
      +

      Add ay'con t' a menu entry

      In th' plank frontmatter, add a pre param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.

      -
      +++
      -title = "GitHub repo"
      -pre = "<i class='fab fa-github'></i> "
      -+++
      -

      Title wit' icon

      +
      +++
      +title = "GitHub repo"
      +pre = "<i class='fab fa-github'></i> "
      ++++
      +

      Title wit' icon

      Order'n sibl'n menu/page entries

      Cap'n Hugo provides a flex'ble way t' handle order fer yer planks.

      Th' simplest way be t' set weight parameter t' a number.

      -
      +++
      -title = "My page"
      -weight = 5
      -+++
      -

      Us'n a custom title fer menu entries

      +
      +++
      +title = "My page"
      +weight = 5
      ++++
      +

      Us'n a custom title fer menu entries

      By default, th' Relearrrn theme will use a page’s title attribute fer th' menu item (or linkTitle if defined).

      But a page’s title has t' be descriptive on its own while th' menu be a hierarchy. We’ve added th' menuTitle parameter fer that purpose:

      For example (for a plank named content/install/linux.md):

      -
      +++
      -title = "Install on Linux"
      -menuTitle = "Linux"
      -+++
      -

      Override expand state rules fer menu entries

      +
      +++
      +title = "Install on Linux"
      +menuTitle = "Linux"
      ++++
      +

      Override expand state rules fer menu entries

      Ye can change how th' theme expands menu entries on th' side o' th' rrrambl'n wit' th' alwaysopen sett'n on a per plank basis. If alwaysopen=false fer any given entry, its children will not be shown 'n th' menu as long as it be not necessary fer th' sake o' navigat'n.

      Th' theme generates th' menu based on th' follow'n rules:

        @@ -286,9 +286,9 @@ We’ve added th' menuTitle parameter fer that purpose:

      - - - + + +
        @@ -403,12 +403,12 @@ We’ve added th' menuTitle parameter fer that purpose:

      - - - - - - + + + + + + - + diff --git a/pir/cont/syntaxhighlight/index.html b/pir/cont/syntaxhighlight/index.html index f5f5208c8c..b826cb3721 100644 --- a/pir/cont/syntaxhighlight/index.html +++ b/pir/cont/syntaxhighlight/index.html @@ -3,29 +3,29 @@ - + Code highlight'n :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -75,48 +75,48 @@

      Marrrkdown rules

      Wrap th' code block wit' three backticks an' th' name o' th' language. Highlight will try t' auto detect th' language if one be not provided.

      -
      ```json
      -[
      -  {
      -    "title": "apples",
      -    "count": [12000, 20000],
      -    "description": {"text": "...", "sensitive": false}
      -  },
      -  {
      -    "title": "oranges",
      -    "count": [17500, null],
      -    "description": {"text": "...", "sensitive": false}
      -  }
      -]
      -```
      -
      +
      ```json
      +[
      +  {
      +    "title": "apples",
      +    "count": [12000, 20000],
      +    "description": {"text": "...", "sensitive": false}
      +  },
      +  {
      +    "title": "oranges",
      +    "count": [17500, null],
      +    "description": {"text": "...", "sensitive": false}
      +  }
      +]
      +```
      +

      Renders t':

      -
      [
      -  {
      -    "title": "apples",
      -    "count": [12000, 20000],
      -    "description": {"text": "...", "sensitive": false}
      -  },
      -  {
      -    "title": "oranges",
      -    "count": [17500, null],
      -    "description": {"text": "...", "sensitive": false}
      -  }
      -]
      -

      Supported languages

      +
      [
      +  {
      +    "title": "apples",
      +    "count": [12000, 20000],
      +    "description": {"text": "...", "sensitive": false}
      +  },
      +  {
      +    "title": "oranges",
      +    "count": [17500, null],
      +    "description": {"text": "...", "sensitive": false}
      +  }
      +]
      +

      Supported languages

      Cap'n Hugo comes wit' a remark'ble list o' supported languages.

      Ye can choose a color theme from th' list o' supported themes an' add it 'n yer config.toml

      -
      [marrrkup]
      -  [marrrkup.highlight]
      -    # if set t' `guessSyntax = true`, there will be no unstyled code even if no language
      -    # was given BUT mermaid code fences will not work anymore! So this be a mandatory
      -    # sett'n fer yer ship
      -    guessSyntax = false
      -
      -    # choose a color theme or create yer own
      -    style = "base16-snazzy"
      -
      +
      [marrrkup]
      +  [marrrkup.highlight]
      +    # if set t' `guessSyntax = true`, there will be no unstyled code even if no language
      +    # was given BUT mermaid code fences will not work anymore! So this be a mandatory
      +    # sett'n fer yer ship
      +    guessSyntax = false
      +
      +    # choose a color theme or create yer own
      +    style = "base16-snazzy"
      +
      @@ -197,9 +197,9 @@ - - - + + +
        @@ -314,12 +314,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/cont/tags/index.html b/pir/cont/tags/index.html index 95d929625d..34e98b4dbc 100644 --- a/pir/cont/tags/index.html +++ b/pir/cont/tags/index.html @@ -3,29 +3,29 @@ - + Tags :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -78,21 +78,21 @@

      Th' Relearrrn theme supports one default taxonomy o' Cap'n Hugo: th' tag feature.

      Configurat'n

      Just add tags t' any plank:

      -
      +++
      -tags = ["tutorial", "theme"]
      -title = "Theme tutorial"
      -weight = 15
      -+++
      -

      Behavior

      +
      +++
      +tags = ["tutorial", "theme"]
      +title = "Theme tutorial"
      +weight = 15
      ++++
      +

      Behavior

      Th' tags be displayed at th' top o' th' plank, 'n their insert'n order.

      Each tag be a link t' a Taxonomy plank display'n all th' articles wit' th' given tag.

      List all th' tags

      In th' config.toml file ye can add a shortcut t' display all th' tags

      -
      [[menu.shortcuts]]
      -name = "<i class='fas fa-tags'></i> Tags"
      -url = "/tags"
      -weight = 30
      -
      +
      [[menu.shortcuts]]
      +name = "<i class='fas fa-tags'></i> Tags"
      +url = "/tags"
      +weight = 30
      +
      @@ -173,9 +173,9 @@ - - - + + +
        @@ -290,12 +290,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/index.html b/pir/index.html index dcac9e1081..acb249a822 100644 --- a/pir/index.html +++ b/pir/index.html @@ -3,30 +3,30 @@ - + Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -196,9 +196,9 @@
      - - - + + +
        @@ -313,12 +313,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/more/credits/index.html b/pir/more/credits/index.html index 1c5d8e4dea..e676084995 100644 --- a/pir/more/credits/index.html +++ b/pir/more/credits/index.html @@ -3,30 +3,30 @@ - + Crrredits :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -171,9 +171,9 @@
      - - - + + +
        @@ -288,12 +288,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/more/showcase/index.html b/pir/more/showcase/index.html index 36253b1a78..cd32a8416b 100644 --- a/pir/more/showcase/index.html +++ b/pir/more/showcase/index.html @@ -3,30 +3,30 @@ - + Showcase :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -156,9 +156,9 @@
      - - - + + +
        @@ -273,12 +273,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/attachments/index.html b/pir/shortcodes/attachments/index.html index 73330c1da3..fd1a4a248b 100644 --- a/pir/shortcodes/attachments/index.html +++ b/pir/shortcodes/attachments/index.html @@ -3,29 +3,29 @@ - + Attachments :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -179,8 +179,8 @@ Currently, it support two implementat'ns fer planks

      Examples

      List o' attachments end'n 'n pdf or mp4

      -
      {{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}}
      -

      renders as

      +
      {{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}}
      +

      renders as

      Related files
      @@ -192,8 +192,8 @@ Currently, it support two implementat'ns fer planks

      Colored styled box

      -
      {{%attachments style="orange" /%}}
      -

      renders as

      +
      {{%attachments style="orange" /%}}
      +

      renders as

      Attachments
      @@ -207,8 +207,8 @@ Currently, it support two implementat'ns fer planks

      -
      {{%attachments style="grey" /%}}
      -

      renders as

      +
      {{%attachments style="grey" /%}}
      +

      renders as

      Attachments
      @@ -222,8 +222,8 @@ Currently, it support two implementat'ns fer planks

      -
      {{%attachments style="blue" /%}}
      -

      renders as

      +
      {{%attachments style="blue" /%}}
      +

      renders as

      Attachments
      @@ -237,8 +237,8 @@ Currently, it support two implementat'ns fer planks

      -
      {{%attachments style="green" /%}}
      -

      renders as

      +
      {{%attachments style="green" /%}}
      +

      renders as

      Attachments
      @@ -333,9 +333,9 @@ Currently, it support two implementat'ns fer planks

      - - - + + +
        @@ -450,12 +450,12 @@ Currently, it support two implementat'ns fer planks

      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/button/index.html b/pir/shortcodes/button/index.html index 51bbd6f991..d12d6e4930 100644 --- a/pir/shortcodes/button/index.html +++ b/pir/shortcodes/button/index.html @@ -3,29 +3,29 @@ - + Button :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -72,10 +72,10 @@

      A button be a just a click'ble button wit' optional ay'con.

      -
      {{% button href="https://gohugo.io/" %}}Get Cap'n Hugo{{% /button %}}
      -{{% button href="https://gohugo.io/" ay'con="fas fa-download" %}}Get Cap'n Hugo wit' ay'con{{% /button %}}
      -{{% button href="https://gohugo.io/" ay'con="fas fa-download" ay'con-posit'n="right" %}}Get Cap'n Hugo wit' ay'con right{{% /button %}}
      -

      +

      {{% button href="https://gohugo.io/" %}}Get Cap'n Hugo{{% /button %}}
      +{{% button href="https://gohugo.io/" ay'con="fas fa-download" %}}Get Cap'n Hugo wit' ay'con{{% /button %}}
      +{{% button href="https://gohugo.io/" ay'con="fas fa-download" ay'con-posit'n="right" %}}Get Cap'n Hugo wit' ay'con right{{% /button %}}
      +

      Get Cap'n Hugo @@ -173,9 +173,9 @@ - - - + + +

        @@ -290,12 +290,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html index 50ee6e5a5a..b263eaf562 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html @@ -3,30 +3,30 @@ - + Plank 1-1-1-1-1-1 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -164,9 +164,9 @@
      - - - + + +
        @@ -285,12 +285,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html index 756567266d..c9ebf0ecdc 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html @@ -3,30 +3,30 @@ - + Plank 1-1-1-1-1 (hidden) :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -169,9 +169,9 @@
      - - - + + +
        @@ -290,12 +290,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html index ac43c209f1..35381a706a 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html @@ -3,30 +3,30 @@ - + Plank 1-1-1-1 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -168,9 +168,9 @@
      - - - + + +
        @@ -287,12 +287,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html index d61e829a45..089e996472 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html @@ -3,30 +3,30 @@ - + Plank 1-1-1 (hidden) :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -167,9 +167,9 @@
      - - - + + +
        @@ -286,12 +286,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html index ab4bc83248..ac527f2c32 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html @@ -3,30 +3,30 @@ - + Plank 1-1-2-1 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -162,9 +162,9 @@
      - - - + + +
        @@ -279,12 +279,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html index c0d8583312..9af15792da 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html @@ -3,30 +3,30 @@ - + Plank 1-1-2-2 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -162,9 +162,9 @@
      - - - + + +
        @@ -279,12 +279,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html index 12b1bc700c..d239b231aa 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html @@ -3,30 +3,30 @@ - + Plank 1-1-2 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -168,9 +168,9 @@
      - - - + + +
        @@ -285,12 +285,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html index ad62eefb71..5daccd527f 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html @@ -3,30 +3,30 @@ - + Plank 1-1-3 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -161,9 +161,9 @@
      - - - + + +
        @@ -278,12 +278,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/children-1-1/index.html b/pir/shortcodes/children/children-1/children-1-1/index.html index c7c7429580..6759930208 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/index.html @@ -3,30 +3,30 @@ - + Plank 1-1 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -168,9 +168,9 @@
      - - - + + +
        @@ -285,12 +285,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-1/index.html b/pir/shortcodes/children/children-1/index.html index a9e2d261c7..61000fbfcd 100644 --- a/pir/shortcodes/children/children-1/index.html +++ b/pir/shortcodes/children/children-1/index.html @@ -3,30 +3,30 @@ - + Plank 1 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -165,9 +165,9 @@
      - - - + + +
        @@ -282,12 +282,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-2/index.html b/pir/shortcodes/children/children-2/index.html index 0baa663b14..0e6fd5fbe8 100644 --- a/pir/shortcodes/children/children-2/index.html +++ b/pir/shortcodes/children/children-2/index.html @@ -3,30 +3,30 @@ - + Plank 2 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -160,9 +160,9 @@
      - - - + + +
        @@ -277,12 +277,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-3/index.html b/pir/shortcodes/children/children-3/index.html index 6f06c3507e..6a629179f1 100644 --- a/pir/shortcodes/children/children-3/index.html +++ b/pir/shortcodes/children/children-3/index.html @@ -3,30 +3,30 @@ - + Plank 3 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -165,9 +165,9 @@
      - - - + + +
        @@ -282,12 +282,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-3/test3/index.html b/pir/shortcodes/children/children-3/test3/index.html index 6b2985f9b4..d5d27f2e49 100644 --- a/pir/shortcodes/children/children-3/test3/index.html +++ b/pir/shortcodes/children/children-3/test3/index.html @@ -3,29 +3,29 @@ - + Plank 3-1 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -159,9 +159,9 @@
      - - - + + +
        @@ -276,12 +276,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/children-4/index.html b/pir/shortcodes/children/children-4/index.html index ec413de6c6..462c883233 100644 --- a/pir/shortcodes/children/children-4/index.html +++ b/pir/shortcodes/children/children-4/index.html @@ -3,30 +3,30 @@ - + Plank 4 (hidden) :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -159,9 +159,9 @@
      - - - + + +
        @@ -277,12 +277,12 @@
      - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/index.html b/pir/shortcodes/children/index.html index ede902ecc4..1e485987b0 100644 --- a/pir/shortcodes/children/index.html +++ b/pir/shortcodes/children/index.html @@ -3,30 +3,30 @@ - + Children :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
      @@ -121,8 +121,8 @@

      Demo

      -
      {{% children  %}}
      -
      +
      {{% children  %}}
      +
      -
      {{% children descript'n="true" %}}
      -
      +
      {{% children descript'n="true" %}}
      +
      • plank X
      • @@ -148,8 +148,8 @@ So its rrrambl'n be used as descript'n.

        This be a demo child plank

      -
      {{% children depth="999" showhidden="true" %}}
      -
      +
      {{% children depth="999" showhidden="true" %}}
      +
    4. plank 4 (hidden)
      • -
        {{% children containerstyle="div" style="h2" depth="3" descript'n="true" %}}
        -
        +
        {{% children containerstyle="div" style="h2" depth="3" descript'n="true" %}}
        +
        @@ -206,8 +206,8 @@ So its rrrambl'n be used as descript'n.

        This be a plain plank test nested 'n a parent

        -
        {{% children containerstyle="div" style="div" depth="999" %}}
        -
        +
        {{% children containerstyle="div" style="div" depth="999" %}}
        +
        @@ -302,9 +302,9 @@ So its rrrambl'n be used as descript'n.

        - - - + + +
          @@ -419,12 +419,12 @@ So its rrrambl'n be used as descript'n.

        - - - - - - + + + + + + - + diff --git a/pir/shortcodes/children/test/index.html b/pir/shortcodes/children/test/index.html index 721cfdbb9b..e3b089c1cb 100644 --- a/pir/shortcodes/children/test/index.html +++ b/pir/shortcodes/children/test/index.html @@ -3,29 +3,29 @@ - + Plank X :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -154,9 +154,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/shortcodes/expand/index.html b/pir/shortcodes/expand/index.html index 349b18261d..0f017b527e 100644 --- a/pir/shortcodes/expand/index.html +++ b/pir/shortcodes/expand/index.html @@ -3,29 +3,29 @@ - + Expand :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -73,10 +73,10 @@

        Th' Expand shorrrtcode displays an expandable/collaps'ble section o' text on yer plank.

        Usage

        -
        {{% expand [ <str'n> [ "true" | "false" ] ] %}}
        -Yes!
        -{{% /expand %}}
        -

        Th' first optional parameter defines th' text that appears next t' th' expand/collapse ay'con. Th' default text be "Expand me...".

        +
        {{% expand [ <str'n> [ "true" | "false" ] ] %}}
        +Yes!
        +{{% /expand %}}
        +

        Th' first optional parameter defines th' text that appears next t' th' expand/collapse ay'con. Th' default text be "Expand me...".

        Th' second optional parameter controls if th' block be initially shown as expanded ("true") or collapsed ("false"). Th' default ist "false".

        Examples

        @@ -112,10 +112,10 @@ Show marrrkup
        -
        {{% expand %}}
        -Yes, ye did it!
        -{{% /expand %}}
        -
        +
        {{% expand %}}
        +Yes, ye did it!
        +{{% /expand %}}
        +

        Initially expanded

        @@ -139,10 +139,10 @@ Show marrrkup
        -
        {{% expand "Expand me..." "true" %}}
        -No need t' press ye!
        -{{% /expand %}}
        -
        +
        {{% expand "Expand me..." "true" %}}
        +No need t' press ye!
        +{{% /expand %}}
        +

        Arbitrary text

        @@ -164,8 +164,8 @@
      • other shorrrtcodes besides expand
      • etc.
      • -
        ...and even source code
        -
        +
        ...and even source code
        +

        th' possiblities be endless

        @@ -179,25 +179,25 @@ Show marrrkup @@ -281,9 +281,9 @@ - - - + + +
          @@ -398,12 +398,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/shortcodes/include/index.html b/pir/shortcodes/include/index.html index 4c737bc0e7..fce84c9676 100644 --- a/pir/shortcodes/include/index.html +++ b/pir/shortcodes/include/index.html @@ -3,29 +3,29 @@ - + Include :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -73,8 +73,8 @@

        Th' include shorrrtcode includes other files from yer project inside o' th' current file. This can even contain Marrrkdown an' will be taken into account when generat'n th' t'ble o' contents.

        Usage

        -
        {{% include <str'n> [ "true" | "false" ] %}}
        -

        Th' first required parameter be th' path t' th' file t' be included.

        +
        {{% include <str'n> [ "true" | "false" ] %}}
        +

        Th' first required parameter be th' path t' th' file t' be included.

        If th' file’s rrrambl'n will be displayed as HTML, th' second optional parameter controls if th' first head'n o' th' included file should be displayed ("true")- which be th' default - or be hidden.

        Examples

        Arbitray rrrambl'n

        @@ -87,8 +87,8 @@
      • other shorrrtcodes besides include
      • etc.
      • -
        ...and even source code
        -
        +
        ...and even source code
        +

        th' possiblities be endless

        @@ -99,8 +99,8 @@ Show marrrkup
        @@ -184,9 +184,9 @@ - - - + + +
          @@ -301,12 +301,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/shortcodes/index.html b/pir/shortcodes/index.html index 376f2ac874..114a8f32bc 100644 --- a/pir/shortcodes/index.html +++ b/pir/shortcodes/index.html @@ -3,30 +3,30 @@ - + Shorrrtcodes :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -197,9 +197,9 @@
        - - - + + +
          @@ -314,12 +314,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/shortcodes/mermaid/index.html b/pir/shortcodes/mermaid/index.html index 4b89503c1c..1f0e0e5e24 100644 --- a/pir/shortcodes/mermaid/index.html +++ b/pir/shortcodes/mermaid/index.html @@ -3,29 +3,29 @@ - + Merrrmaid :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -74,17 +74,17 @@

        Merrrmaid be a library help'n ye t' generate diagram an' flowcharts from text, 'n a similar manner as Marrrkdown.

        Usage

        Just insert yer Merrrmaid code 'n th' mermaid shorrrtcode like this:

        -
        {{< mermaid [ align=("left"|"right"|"center"|"justify") ] >}}
        -classDiagram
        -    Person *-- Dog
        -{{< /mermaid >}}
        -

        Ye can set an optional align attribute which defaults t' "center".

        +
        {{< mermaid [ align=("left"|"right"|"center"|"justify") ] >}}
        +classDiagram
        +    Person *-- Dog
        +{{< /mermaid >}}
        +

        Ye can set an optional align attribute which defaults t' "center".

        If ye don’t need alignment ye can use th' alternative rules us'n code fences if ye have turned off guessSyntax fer th' marrrkup.highlight sett'n (see below):

        -
        ```mermaid
        -classDiagram
        -    Person *-- Dog
        -```
        -

        Th' generated graphs can be be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.

        +
        ```mermaid
        +classDiagram
        +    Person *-- Dog
        +```
        +

        Th' generated graphs can be be panned by dragg'n them an' zoomed by us'n th' mousewheel. On mobile devices ye can use finger gestures.

        Examples

        Flowchart

        @@ -104,14 +104,14 @@ graph LR; Show marrrkup
        -
        {{< mermaid align="left" >}}
        -graph LR;
        -    A[Hard edge] -->|Link text| B(Round edge)
        -    B --> C{<strong>Decision</strong>}
        -    C -->|One| D[Result one]
        -    C -->|Two| E[Result two]
        -{{< /mermaid >}}
        -
        +
        {{< mermaid align="left" >}}
        +graph LR;
        +    A[Hard edge] -->|Link text| B(Round edge)
        +    B --> C{<strong>Decision</strong>}
        +    C -->|One| D[Result one]
        +    C -->|Two| E[Result two]
        +{{< /mermaid >}}
        +

        Sequence

        @@ -138,20 +138,20 @@ sequenceDiagram Show marrrkup
        -
        {{< mermaid >}}
        -sequenceDiagram
        -    participant Alice
        -    participant Bob
        -    Alice->>John: Hello John, how be ye?
        -    loop Healthcheck
        -        John->John: Fight against hypochondria
        -    end
        -    Avast right o' John: Rational thoughts <br/>prevail...
        -    John-->Alice: Great!
        -    John->Bob: How about ye?
        -    Bob-->John: Jolly bloody!
        -{{< /mermaid >}}
        -
        +
        {{< mermaid >}}
        +sequenceDiagram
        +    participant Alice
        +    participant Bob
        +    Alice->>John: Hello John, how be ye?
        +    loop Healthcheck
        +        John->John: Fight against hypochondria
        +    end
        +    Avast right o' John: Rational thoughts <br/>prevail...
        +    John-->Alice: Great!
        +    John->Bob: How about ye?
        +    Bob-->John: Jolly bloody!
        +{{< /mermaid >}}
        +

        GANTT

        @@ -182,24 +182,24 @@ gantt Show marrrkup
        -
        {{< mermaid >}}
        -gantt
        -        dateFormat  YYYY-MM-DD
        -        title Add'n GANTT diagram functionality t' Merrrmaid
        -        section A section
        -        Completed task            :done,    des1, 2014-01-06,2014-01-08
        -        Active task               :active,  des2, 2014-01-09, 3d
        -        Future task               :         des3, aft des2, 5d
        -        Future task2              :         des4, aft des3, 5d
        -        section Critical tasks
        -        Completed task 'n th' critical line :crit, done, 2014-01-06,24h
        -        Implement parser an' jison          :crit, done, aft des1, 2d
        -        Create tests fer parser             :crit, active, 3d
        -        Future task 'n critical line        :crit, 5d
        -        Create tests fer renderer           :2d
        -        Add t' Merrrmaid                      :1d
        -{{< /mermaid >}}
        -
        +
        {{< mermaid >}}
        +gantt
        +        dateFormat  YYYY-MM-DD
        +        title Add'n GANTT diagram functionality t' Merrrmaid
        +        section A section
        +        Completed task            :done,    des1, 2014-01-06,2014-01-08
        +        Active task               :active,  des2, 2014-01-09, 3d
        +        Future task               :         des3, aft des2, 5d
        +        Future task2              :         des4, aft des3, 5d
        +        section Critical tasks
        +        Completed task 'n th' critical line :crit, done, 2014-01-06,24h
        +        Implement parser an' jison          :crit, done, aft des1, 2d
        +        Create tests fer parser             :crit, active, 3d
        +        Future task 'n critical line        :crit, 5d
        +        Create tests fer renderer           :2d
        +        Add t' Merrrmaid                      :1d
        +{{< /mermaid >}}
        +

        Class

        @@ -229,23 +229,23 @@ classDiagram Show marrrkup
        -
        {{< mermaid >}}
        -classDiagram
        -    Class01 <|-- AveryLongClass : Cool
        -    Class03 *-- Class04
        -    Class05 o-- Class06
        -    Class07 .. Class08
        -    Class09 --> C2 : Whar' am i?
        -    Class09 --* C3
        -    Class09 --|> Class07
        -    Class07 : equals()
        -    Class07 : Object[] elementData
        -    Class01 : size()
        -    Class01 : int chimp
        -    Class01 : int gorilla
        -    Class08 <--> C2: Cool label
        -{{< /mermaid >}}
        -
        +
        {{< mermaid >}}
        +classDiagram
        +    Class01 <|-- AveryLongClass : Cool
        +    Class03 *-- Class04
        +    Class05 o-- Class06
        +    Class07 .. Class08
        +    Class09 --> C2 : Whar' am i?
        +    Class09 --* C3
        +    Class09 --|> Class07
        +    Class07 : equals()
        +    Class07 : Object[] elementData
        +    Class01 : size()
        +    Class01 : int chimp
        +    Class01 : int gorilla
        +    Class08 <--> C2: Cool label
        +{{< /mermaid >}}
        +

        State

        @@ -265,17 +265,17 @@ classDiagram Show marrrkup
        -
        ```mermaid
        -stateDiagram-v2
        -    open: Open Door
        -    closed: Closed Door
        -    locked: Locked Door
        -    open   --> closed: Close
        -    closed --> locked: Lock
        -    locked --> closed: Unlock
        -    closed --> open: Open
        -```
        -
        +
        ```mermaid
        +stateDiagram-v2
        +    open: Open Door
        +    closed: Closed Door
        +    locked: Locked Door
        +    open   --> closed: Close
        +    closed --> locked: Lock
        +    locked --> closed: Unlock
        +    closed --> open: Open
        +```
        +

        Configurat'n

        @@ -292,20 +292,20 @@ classDiagram

        Example

        -
        [params]
        -  mermaidInitialize = "{ \"theme\": \"dark\" }"
        -
        -[marrrkup]
        -  [marrrkup.highlight]
        -    # if set t' `guessSyntax = true`, there will be no unstyled code even if no language
        -    # was given BUT mermaid code fences will not work anymore! So this be a mandatory
        -    # sett'n fer yer ship
        -    guessSyntax = false
        -

        or planks frontmatter

        -
        +++
        -mermaidInitialize = "{ \"theme\": \"dark\" }"
        -+++
        -
        +
        [params]
        +  mermaidInitialize = "{ \"theme\": \"dark\" }"
        +
        +[marrrkup]
        +  [marrrkup.highlight]
        +    # if set t' `guessSyntax = true`, there will be no unstyled code even if no language
        +    # was given BUT mermaid code fences will not work anymore! So this be a mandatory
        +    # sett'n fer yer ship
        +    guessSyntax = false
        +

        or planks frontmatter

        +
        +++
        +mermaidInitialize = "{ \"theme\": \"dark\" }"
        ++++
        +
        @@ -386,9 +386,9 @@ classDiagram - - - + + +
          @@ -503,12 +503,12 @@ classDiagram
        - - - - - - + + + + + + - + diff --git a/pir/shortcodes/notice/index.html b/pir/shortcodes/notice/index.html index ecfc9ebaab..5a7ed5008b 100644 --- a/pir/shortcodes/notice/index.html +++ b/pir/shortcodes/notice/index.html @@ -3,29 +3,29 @@ - + Notice :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -73,10 +73,10 @@

        Th' notice shorrrtcode shows four types o' disclaimers t' help ye structure yer plank.

        Usage

        -
        {{% notice ( note | info | tip | warning ) [ <str'n> ] %}}
        -Some marrrkup
        -{{% /notice %}}
        -

        Th' first parameter be required an' indicates th' type o' notice.

        +
        {{% notice ( note | info | tip | warning ) [ <str'n> ] %}}
        +Some marrrkup
        +{{% /notice %}}
        +

        Th' first parameter be required an' indicates th' type o' notice.

        Th' second parameter be optional. If provided, it will be used as th' title o' th' notice. If not provided, then th' type o' notice will be used as th' title. For example, th' title o' a warning notice will be “Warning”.

        Examples

        Avast

        @@ -94,8 +94,8 @@
      • other shorrrtcodes besides notice
      • etc.
      • -
        ...and even source code
        -
        +
        ...and even source code
        +

        th' possiblities be endless

        @@ -109,25 +109,25 @@ Show marrrkup

        Ahoi

        @@ -145,8 +145,8 @@
      • other shorrrtcodes besides notice
      • etc.
      • -
        ...and even source code
        -
        +
        ...and even source code
        +

        th' possiblities be endless

        @@ -160,25 +160,25 @@ Show marrrkup

        Smarrrt Arrrse

        @@ -196,8 +196,8 @@
      • other shorrrtcodes besides notice
      • etc.
      • -
        ...and even source code
        -
        +
        ...and even source code
        +

        th' possiblities be endless

        @@ -211,25 +211,25 @@ Show marrrkup

        Arrr

        @@ -247,8 +247,8 @@
      • other shorrrtcodes besides notice
      • etc.
      • -
        ...and even source code
        -
        +
        ...and even source code
        +

        th' possiblities be endless

        @@ -262,25 +262,25 @@ Show marrrkup

        Notice wit' custom title an' default color

        @@ -301,10 +301,10 @@ Show marrrkup @@ -388,9 +388,9 @@ - - - + + +
          @@ -505,12 +505,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/shortcodes/siteparam/index.html b/pir/shortcodes/siteparam/index.html index ec4035d374..d74a174783 100644 --- a/pir/shortcodes/siteparam/index.html +++ b/pir/shortcodes/siteparam/index.html @@ -3,29 +3,29 @@ - + Ship param :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -73,15 +73,15 @@

        Th' siteparam shorrrtcode be used t' help ye print values o' ship params.

        Usage

        -
        {{% siteparam <str'n> %}}
        -

        Th' first required parameter be th' name o' th' ship param t' be displayed.

        +
        {{% siteparam <str'n> %}}
        +

        Th' first required parameter be th' name o' th' ship param t' be displayed.

        Examples

        For instance, 'n this current ship, th' editURL vari'ble be used 'n config.toml

        -
        [params]
        -  editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"
        -

        Use th' siteparam shorrrtcode t' display its value.

        -
        `editURL` Value : {{% siteparam "editURL" %}}
        -

        be displayed as

        +
        [params]
        +  editURL = "https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/"
        +

        Use th' siteparam shorrrtcode t' display its value.

        +
        `editURL` Value : {{% siteparam "editURL" %}}
        +

        be displayed as

        editURL Value : https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/

        @@ -164,9 +164,9 @@
        - - - + + +
          @@ -281,12 +281,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/shortcodes/tabs/index.html b/pir/shortcodes/tabs/index.html index 4948b5fb81..b7b6389373 100644 --- a/pir/shortcodes/tabs/index.html +++ b/pir/shortcodes/tabs/index.html @@ -3,29 +3,29 @@ - + Tabbed views :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -74,24 +74,24 @@

        Choose which rrrambl'n t' see across th' plank. Very handy fer provid'n code snippets fer multiple languages or provid'n configurat'n 'n different formats.

        Code example

        -
        {{< tabs >}}
        -{{% tab name="python" %}}
        -```python
        -print("Hello World!")
        -```
        -{{% /tab %}}
        -{{% tab name="R" %}}
        -```R
        -> print("Hello World!")
        -```
        -{{% /tab %}}
        -{{% tab name="Bash" %}}
        -```Bash
        -echo "Hello World!"
        -```
        -{{% /tab %}}
        -{{< /tabs >}}
        -

        Renders as:

        +
        {{< tabs >}}
        +{{% tab name="python" %}}
        +```python
        +print("Hello World!")
        +```
        +{{% /tab %}}
        +{{% tab name="R" %}}
        +```R
        +> print("Hello World!")
        +```
        +{{% /tab %}}
        +{{% tab name="Bash" %}}
        +```Bash
        +echo "Hello World!"
        +```
        +{{% /tab %}}
        +{{< /tabs >}}
        +

        Renders as:

        @@ -116,16 +116,16 @@ snippets fer multiple languages or provid'n configurat'n 'n different formats.
        -
        print("Hello World!")
        -
        +
        print("Hello World!")
        +
        -
        > print("Hello World!")
        -
        +
        > print("Hello World!")
        +
        -
        echo "Hello World!"
        -
        +
        echo "Hello World!"
        +
        @@ -155,41 +155,41 @@ snippets fer multiple languages or provid'n configurat'n 'n different formats.
        -
        print("Hello World!")
        -
        +
        print("Hello World!")
        +
        -
        > print("Hello World!")
        -
        +
        > print("Hello World!")
        +
        -
        echo "Hello World!"
        -
        +
        echo "Hello World!"
        +

        Config example

        -
        {{< tabs groupId="config" >}}
        -{{% tab name="json" %}}
        -```json
        -{
        -  "Hello": "World"
        -}
        -```
        -{{% /tab %}}
        -{{% tab name="XML" %}}
        -```xml
        -<Hello>World</Hello>
        -```
        -{{% /tab %}}
        -{{% tab name="properties" %}}
        -```properties
        -Hello = World
        -```
        -{{% /tab %}}
        -{{< /tabs >}}
        -

        Renders as:

        +
        {{< tabs groupId="config" >}}
        +{{% tab name="json" %}}
        +```json
        +{
        +  "Hello": "World"
        +}
        +```
        +{{% /tab %}}
        +{{% tab name="XML" %}}
        +```xml
        +<Hello>World</Hello>
        +```
        +{{% /tab %}}
        +{{% tab name="properties" %}}
        +```properties
        +Hello = World
        +```
        +{{% /tab %}}
        +{{< /tabs >}}
        +

        Renders as:

        @@ -214,18 +214,18 @@ snippets fer multiple languages or provid'n configurat'n 'n different formats.
        -
        {
        -  "Hello": "World"
        -}
        -
        +
        {
        +  "Hello": "World"
        +}
        +
        -
        <Hello>World</Hello>
        -
        +
        <Hello>World</Hello>
        +
        -
        Hello = World
        -
        +
        Hello = World
        +
        @@ -323,9 +323,9 @@ from th' 'default' group on a different plank then all tabs will be
        - - - + + +
          @@ -440,12 +440,12 @@ from th' 'default' group on a different plank then all tabs will be
        - - - - - - + + + + + + - + diff --git a/pir/tags/children/index.html b/pir/tags/children/index.html index eb118eba50..ddc7030385 100644 --- a/pir/tags/children/index.html +++ b/pir/tags/children/index.html @@ -3,30 +3,30 @@ - + children :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -153,9 +153,9 @@
        - - - + + +
          @@ -270,12 +270,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/tags/documentatn/index.html b/pir/tags/documentatn/index.html index 5100f342bb..76d72cdadf 100644 --- a/pir/tags/documentatn/index.html +++ b/pir/tags/documentatn/index.html @@ -3,30 +3,30 @@ - + documentat'n :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -140,9 +140,9 @@
        - - - + + +
          @@ -256,12 +256,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/tags/hidden/index.html b/pir/tags/hidden/index.html index 6c1166eebd..c398107f46 100644 --- a/pir/tags/hidden/index.html +++ b/pir/tags/hidden/index.html @@ -3,30 +3,30 @@ - + hidden :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -144,9 +144,9 @@
        - - - + + +
          @@ -261,12 +261,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/tags/index.html b/pir/tags/index.html index 809447b8e0..5b349e760a 100644 --- a/pir/tags/index.html +++ b/pir/tags/index.html @@ -3,30 +3,30 @@ - + Tags :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -260,12 +260,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/tags/non-hidden/index.html b/pir/tags/non-hidden/index.html index 259d62810e..3167e9c1fa 100644 --- a/pir/tags/non-hidden/index.html +++ b/pir/tags/non-hidden/index.html @@ -3,30 +3,30 @@ - + non-hidden :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -148,9 +148,9 @@
        - - - + + +
          @@ -265,12 +265,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/tags/tutorrrial/index.html b/pir/tags/tutorrrial/index.html index c776f0ee9b..6867a6e6a8 100644 --- a/pir/tags/tutorrrial/index.html +++ b/pir/tags/tutorrrial/index.html @@ -3,30 +3,30 @@ - + tutorrrial :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -140,9 +140,9 @@
        - - - + + +
          @@ -256,12 +256,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/tests/code/index.html b/pir/tests/code/index.html index bffdee681f..fd9f65f46a 100644 --- a/pir/tests/code/index.html +++ b/pir/tests/code/index.html @@ -3,30 +3,30 @@ - + Code :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -82,10 +82,10 @@

        Can we just use a simple HTML element ?

        Block Code

        Code fences without any selected language
        -
        {
        -  "well": "some JSON 'n codefences 'n here"
        -}
        -
        {
        +
        {
        +  "well": "some JSON 'n codefences 'n here"
        +}
        +
        {
           "well": "some JSON 'n HTML elements here"
         }
         
        @@ -176,9 +176,9 @@ Some preformatted stuff 'n HTML elements
        - - - + + +
          @@ -295,12 +295,12 @@ Some preformatted stuff 'n HTML elements
        - - - - - - + + + + + + - + diff --git a/pir/tests/index.html b/pir/tests/index.html index 8da845ca10..5633b4ecc6 100644 --- a/pir/tests/index.html +++ b/pir/tests/index.html @@ -3,30 +3,30 @@ - + Tests :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -166,9 +166,9 @@ What about wrapp'n long inline code if multiple sections be written side567/by34
        - - - + + +
          @@ -285,12 +285,12 @@ What about wrapp'n long inline code if multiple sections be written side567/by34
        - - - - - - + + + + + + - + diff --git a/pir/yours/1/index.html b/pir/yours/1/index.html index 787273bd4f..9e8bd6f070 100644 --- a/pir/yours/1/index.html +++ b/pir/yours/1/index.html @@ -3,29 +3,29 @@ - + 1 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/10/index.html b/pir/yours/10/index.html index d349d9b342..3fdc6e9c87 100644 --- a/pir/yours/10/index.html +++ b/pir/yours/10/index.html @@ -3,29 +3,29 @@ - + 11 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/2/index.html b/pir/yours/2/index.html index 6029fedfe0..7f9e91ba3a 100644 --- a/pir/yours/2/index.html +++ b/pir/yours/2/index.html @@ -3,29 +3,29 @@ - + 2 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/3/index.html b/pir/yours/3/index.html index 1b0344d75b..dcbc9ccd8f 100644 --- a/pir/yours/3/index.html +++ b/pir/yours/3/index.html @@ -3,29 +3,29 @@ - + 3 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/4/index.html b/pir/yours/4/index.html index 94f8259359..53c4d2fae5 100644 --- a/pir/yours/4/index.html +++ b/pir/yours/4/index.html @@ -3,29 +3,29 @@ - + 4 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/5/index.html b/pir/yours/5/index.html index dbfb49990e..1cbf0c5c15 100644 --- a/pir/yours/5/index.html +++ b/pir/yours/5/index.html @@ -3,29 +3,29 @@ - + 5 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/6/index.html b/pir/yours/6/index.html index 7d68598911..33aca907f6 100644 --- a/pir/yours/6/index.html +++ b/pir/yours/6/index.html @@ -3,29 +3,29 @@ - + 6 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/7/index.html b/pir/yours/7/index.html index 6efbeab91c..398bf9ac69 100644 --- a/pir/yours/7/index.html +++ b/pir/yours/7/index.html @@ -3,29 +3,29 @@ - + 7 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/8/index.html b/pir/yours/8/index.html index db6aafa6e1..39d61c5f27 100644 --- a/pir/yours/8/index.html +++ b/pir/yours/8/index.html @@ -3,29 +3,29 @@ - + 8 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/9/index.html b/pir/yours/9/index.html index 1fea7d71ff..fefa35ba89 100644 --- a/pir/yours/9/index.html +++ b/pir/yours/9/index.html @@ -3,29 +3,29 @@ - + 9 :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -143,9 +143,9 @@
        - - - + + +
          @@ -271,12 +271,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/children-1/index.html b/pir/yours/children-1/index.html index 965f40c332..cc153572c5 100644 --- a/pir/yours/children-1/index.html +++ b/pir/yours/children-1/index.html @@ -3,30 +3,30 @@ - + Th' one an' only hidden child :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -154,9 +154,9 @@
        - - - + + +
          @@ -283,12 +283,12 @@
        - - - - - - + + + + + + - + diff --git a/pir/yours/index.html b/pir/yours/index.html index 415a2b6193..ff227dfd12 100644 --- a/pir/yours/index.html +++ b/pir/yours/index.html @@ -3,30 +3,30 @@ - + This could be yers :: Cap'n Hugo Relearrrn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -154,9 +154,9 @@
        - - - + + +
          @@ -282,12 +282,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/attachments/index.html b/shortcodes/attachments/index.html index 9588585d94..498ea4328f 100644 --- a/shortcodes/attachments/index.html +++ b/shortcodes/attachments/index.html @@ -3,29 +3,29 @@ - + Attachments :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -178,8 +178,8 @@ Currently, it support two implementations for pages

        Examples

        List of attachments ending in pdf or mp4

        -
        {{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}}
        -

        renders as

        +
        {{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}}
        +

        renders as

        Related files
        @@ -191,8 +191,8 @@ Currently, it support two implementations for pages

        Colored styled box

        -
        {{%attachments style="orange" /%}}
        -

        renders as

        +
        {{%attachments style="orange" /%}}
        +

        renders as

        Attachments
        @@ -206,8 +206,8 @@ Currently, it support two implementations for pages

        -
        {{%attachments style="grey" /%}}
        -

        renders as

        +
        {{%attachments style="grey" /%}}
        +

        renders as

        Attachments
        @@ -221,8 +221,8 @@ Currently, it support two implementations for pages

        -
        {{%attachments style="blue" /%}}
        -

        renders as

        +
        {{%attachments style="blue" /%}}
        +

        renders as

        Attachments
        @@ -236,8 +236,8 @@ Currently, it support two implementations for pages

        -
        {{%attachments style="green" /%}}
        -

        renders as

        +
        {{%attachments style="green" /%}}
        +

        renders as

        Attachments
        @@ -331,9 +331,9 @@ Currently, it support two implementations for pages

        - - - + + +
          @@ -448,12 +448,12 @@ Currently, it support two implementations for pages

        - - - - - - + + + + + + - + diff --git a/shortcodes/button/index.html b/shortcodes/button/index.html index d63512b882..c79c7967ba 100644 --- a/shortcodes/button/index.html +++ b/shortcodes/button/index.html @@ -3,29 +3,29 @@ - + Button :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -64,10 +64,10 @@

        Button

        A button is a just a clickable button with optional icon.

        -
        {{% 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 %}}
        -

        +

        {{% 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 @@ -164,9 +164,9 @@

        - - - + + +
          @@ -281,12 +281,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html index b1e9f09561..d5737c817e 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/children-1-1-1-1-1-1/index.html @@ -3,30 +3,30 @@ - + page 1-1-1-1-1-1 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -155,9 +155,9 @@
        - - - + + +
          @@ -276,12 +276,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html index 37c6ae263d..78e01a8987 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/index.html @@ -3,30 +3,30 @@ - + page 1-1-1-1-1 (hidden) :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -170,9 +170,9 @@
        - - - + + +
          @@ -291,12 +291,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html index b61ab469d2..4fa790121a 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.html @@ -3,30 +3,30 @@ - + page 1-1-1-1 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -169,9 +169,9 @@
        - - - + + +
          @@ -288,12 +288,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html index 2b8f11a7f0..a4e7f2f5af 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-1/index.html @@ -3,30 +3,30 @@ - + page 1-1-1 (hidden) :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -168,9 +168,9 @@
        - - - + + +
          @@ -287,12 +287,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html index 8c7dad2662..60bb35598d 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html @@ -3,30 +3,30 @@ - + page 1-1-2-1 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -153,9 +153,9 @@
        - - - + + +
          @@ -270,12 +270,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html index a1d2ab775b..7f9e7490ac 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html @@ -3,30 +3,30 @@ - + page 1-1-2-2 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -153,9 +153,9 @@
        - - - + + +
          @@ -270,12 +270,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html index 6e6f1e4682..397877aafe 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-2/index.html @@ -3,30 +3,30 @@ - + page 1-1-2 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -169,9 +169,9 @@
        - - - + + +
          @@ -286,12 +286,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html index c9844ffdce..a2b592f34c 100644 --- a/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html +++ b/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html @@ -3,30 +3,30 @@ - + page 1-1-3 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -152,9 +152,9 @@
        - - - + + +
          @@ -269,12 +269,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/children-1-1/index.html b/shortcodes/children/children-1/children-1-1/index.html index f26822a5a7..8ff9fa1fd7 100644 --- a/shortcodes/children/children-1/children-1-1/index.html +++ b/shortcodes/children/children-1/children-1-1/index.html @@ -3,30 +3,30 @@ - + page 1-1 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -169,9 +169,9 @@
        - - - + + +
          @@ -286,12 +286,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-1/index.html b/shortcodes/children/children-1/index.html index 7dbe413153..d96d2551ce 100644 --- a/shortcodes/children/children-1/index.html +++ b/shortcodes/children/children-1/index.html @@ -3,30 +3,30 @@ - + page 1 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -166,9 +166,9 @@
        - - - + + +
          @@ -283,12 +283,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-2/index.html b/shortcodes/children/children-2/index.html index d5f0fe62db..3848159764 100644 --- a/shortcodes/children/children-2/index.html +++ b/shortcodes/children/children-2/index.html @@ -3,30 +3,30 @@ - + page 2 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -151,9 +151,9 @@
        - - - + + +
          @@ -268,12 +268,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-3/index.html b/shortcodes/children/children-3/index.html index 5faba7ffdb..cb7ee20eae 100644 --- a/shortcodes/children/children-3/index.html +++ b/shortcodes/children/children-3/index.html @@ -3,30 +3,30 @@ - + page 3 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -166,9 +166,9 @@
        - - - + + +
          @@ -283,12 +283,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-3/test3/index.html b/shortcodes/children/children-3/test3/index.html index fc9991e5b2..25664b7d1f 100644 --- a/shortcodes/children/children-3/test3/index.html +++ b/shortcodes/children/children-3/test3/index.html @@ -3,29 +3,29 @@ - + page 3-1 :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -150,9 +150,9 @@
        - - - + + +
          @@ -267,12 +267,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/children-4/index.html b/shortcodes/children/children-4/index.html index 2e15de4916..0c4db76c37 100644 --- a/shortcodes/children/children-4/index.html +++ b/shortcodes/children/children-4/index.html @@ -3,30 +3,30 @@ - + page 4 (hidden) :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -150,9 +150,9 @@
        - - - + + +
          @@ -268,12 +268,12 @@
        - - - - - - + + + + + + - + diff --git a/shortcodes/children/index.html b/shortcodes/children/index.html index ffd6b0b674..55cfafe72e 100644 --- a/shortcodes/children/index.html +++ b/shortcodes/children/index.html @@ -3,30 +3,30 @@ - + Children :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
        @@ -124,8 +124,8 @@

        Demo

        -
        {{% children  %}}
        -
        +
        {{% children  %}}
        +
        -
        {{% children description="true" %}}
        -
        +
        {{% children description="true" %}}
        +
        • page X
        • @@ -151,8 +151,8 @@ So its content is used as description.

          This is a demo child page

        -
        {{% children depth="999" showhidden="true" %}}
        -
        +
        {{% children depth="999" showhidden="true" %}}
        +
        • page X
          • @@ -171,8 +171,8 @@ So its content is used as description.

          • page 3-1
          • page 4 (hidden)
            • -
              {{% children containerstyle="div" style="h2" depth="3" description="true" %}}
              -
              +
              {{% children containerstyle="div" style="h2" depth="3" description="true" %}}
              +
              @@ -209,8 +209,8 @@ So its content is used as description.

              This is a plain page test nested in a parent

              -
              {{% children containerstyle="div" style="div" depth="999" %}}
              -
              +
              {{% children containerstyle="div" style="div" depth="999" %}}
              +
              @@ -304,9 +304,9 @@ So its content is used as description.

              - - - + + +
                @@ -421,12 +421,12 @@ So its content is used as description.

              - - - - - - + + + + + + - + diff --git a/shortcodes/children/test/index.html b/shortcodes/children/test/index.html index 2ee6894885..d530e06b84 100644 --- a/shortcodes/children/test/index.html +++ b/shortcodes/children/test/index.html @@ -3,30 +3,30 @@ - + page X :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
              @@ -146,9 +146,9 @@
              - - - + + +
                @@ -263,12 +263,12 @@
              - - - - - - + + + + + + - + diff --git a/shortcodes/expand/index.html b/shortcodes/expand/index.html index 7b067b3092..af31ff702b 100644 --- a/shortcodes/expand/index.html +++ b/shortcodes/expand/index.html @@ -3,29 +3,29 @@ - + Expand :: Hugo Relearn Theme - - - - - - - - - - - + + + + + + + + + + + - + - +
              @@ -82,10 +82,10 @@

              The Expand shortcode displays an expandable/collapsible section of text on your page.

              Usage

              -
              {{% expand [ <string> [ "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...".

              +
              {{% expand [ <string> [ "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...".

              The second optional parameter controls if the block is initially shown as expanded ("true") or collapsed ("false"). The default ist "false".

              Examples

              @@ -121,10 +121,10 @@ Show markup
              -
              {{% expand %}}
              -Yes, you did it!
              -{{% /expand %}}
              -
              +
              {{% expand %}}
              +Yes, you did it!
              +{{% /expand %}}
              +

              Initially expanded

              @@ -148,10 +148,10 @@ Show markup
              -
              {{% expand "Expand me..." "true" %}}
              -No need to press you!
              -{{% /expand %}}
              -
              +
              {{% expand "Expand me..." "true" %}}
              +No need to press you!
              +{{% /expand %}}
              +

              Arbitrary text

              @@ -173,8 +173,8 @@
            • other shortcodes besides expand
            • etc.
            • -
              ...and even source code
              -
              +
              ...and even source code
              +

              the possiblities are endless

              @@ -188,25 +188,25 @@ Show markup