diff --git a/404.html b/404.html index bcff94431e..73f19b1f7b 100644 --- a/404.html +++ b/404.html @@ -19,21 +19,21 @@ 404 Page not found :: Hugo Relearn Theme - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/branding/index.print.html b/basics/branding/index.print.html index 025e54ed6c..743f91e67f 100644 --- a/basics/branding/index.print.html +++ b/basics/branding/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/changelog/index.html b/basics/changelog/index.html index 7ef740ee85..cddc5db971 100644 --- a/basics/changelog/index.html +++ b/basics/changelog/index.html @@ -20,21 +20,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/changelog/index.print.html b/basics/changelog/index.print.html index dcd60b2f49..a13cb2bd1d 100644 --- a/basics/changelog/index.print.html +++ b/basics/changelog/index.print.html @@ -20,22 +20,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/configuration/index.html b/basics/configuration/index.html index 5b78cbc761..4c48c085f4 100644 --- a/basics/configuration/index.html +++ b/basics/configuration/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/configuration/index.print.html b/basics/configuration/index.print.html index d5a52aaae5..7b8f9e93fe 100644 --- a/basics/configuration/index.print.html +++ b/basics/configuration/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/customization/index.html b/basics/customization/index.html index ebee69b038..f4efd2b15d 100644 --- a/basics/customization/index.html +++ b/basics/customization/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/customization/index.print.html b/basics/customization/index.print.html index 124c55304a..e594ea4b2f 100644 --- a/basics/customization/index.print.html +++ b/basics/customization/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/generator/index.html b/basics/generator/index.html index b63b7ded7c..2ff1b0d7ac 100644 --- a/basics/generator/index.html +++ b/basics/generator/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/generator/index.print.html b/basics/generator/index.print.html index 547b5b1c1b..51bb8bcb7e 100644 --- a/basics/generator/index.print.html +++ b/basics/generator/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/history/index.html b/basics/history/index.html index bd6bd8a069..bb6e6387a2 100644 --- a/basics/history/index.html +++ b/basics/history/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/history/index.print.html b/basics/history/index.print.html index 66367a0486..103ddd95a5 100644 --- a/basics/history/index.print.html +++ b/basics/history/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/index.html b/basics/index.html index 99a11c0e0b..6eecf34d40 100644 --- a/basics/index.html +++ b/basics/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/index.print.html b/basics/index.print.html index dd051cb796..6fc41d123d 100644 --- a/basics/index.print.html +++ b/basics/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/basics/installation/index.html b/basics/installation/index.html index cdfbdaa49e..b38266fad8 100644 --- a/basics/installation/index.html +++ b/basics/installation/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/installation/index.print.html b/basics/installation/index.print.html index 67e3de8688..617590d39e 100644 --- a/basics/installation/index.print.html +++ b/basics/installation/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/migration/index.html b/basics/migration/index.html index 0a670557ee..e8eb697b4b 100644 --- a/basics/migration/index.html +++ b/basics/migration/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/migration/index.print.html b/basics/migration/index.print.html index d8e113f776..9b1e40d942 100644 --- a/basics/migration/index.print.html +++ b/basics/migration/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/requirements/index.html b/basics/requirements/index.html index 80972bdc38..4d6791b0b6 100644 --- a/basics/requirements/index.html +++ b/basics/requirements/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/requirements/index.print.html b/basics/requirements/index.print.html index 63ad23a597..dc009bd9b0 100644 --- a/basics/requirements/index.print.html +++ b/basics/requirements/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/basics/topbar/index.html b/basics/topbar/index.html index 156b1197ad..1c9a3415b5 100644 --- a/basics/topbar/index.html +++ b/basics/topbar/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/basics/topbar/index.print.html b/basics/topbar/index.print.html index a8f6364eaa..75252acc2a 100644 --- a/basics/topbar/index.print.html +++ b/basics/topbar/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/categories/basic/index.html b/categories/basic/index.html index 47a6a17b53..b922775e40 100644 --- a/categories/basic/index.html +++ b/categories/basic/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/content/index.html b/categories/content/index.html index 6f07039fd0..f9517d79c0 100644 --- a/categories/content/index.html +++ b/categories/content/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/custom/index.html b/categories/custom/index.html index c36c2d03aa..2a3a29d41a 100644 --- a/categories/custom/index.html +++ b/categories/custom/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/index.html b/categories/index.html index 7d3afc33e9..5d0f22359f 100644 --- a/categories/index.html +++ b/categories/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/taxonomy/index.html b/categories/taxonomy/index.html index 282e7666bd..afe652fd82 100644 --- a/categories/taxonomy/index.html +++ b/categories/taxonomy/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/categories/theming/index.html b/categories/theming/index.html index 7c6227bf23..eec5703d8b 100644 --- a/categories/theming/index.html +++ b/categories/theming/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/config/_default/params.toml b/config/_default/params.toml index 68ca3c3f1c..8c65dd2ce3 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -214,8 +214,10 @@ disableLanguageSwitchingButton = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden pages # These options configure how hidden pages are treated. -# A page flagged as hidden, is only removed from the main menu but behaves -# like any other page for all other functionality in Hugo. +# A page flagged as hidden, is only removed from the main menu if you are +# currently not on this page or the hidden page is not part of current page's +# ancestors. For all other functionality in Hugo a hidden page behaves like any +# other page if not otherwise configured. # Hide hidden pages from search. # Default: false diff --git a/cont/archetypes/index.html b/cont/archetypes/index.html index fc67f9e7d3..132ac934e2 100644 --- a/cont/archetypes/index.html +++ b/cont/archetypes/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/archetypes/index.print.html b/cont/archetypes/index.print.html index 9a3176ae9b..2e4e66944a 100644 --- a/cont/archetypes/index.print.html +++ b/cont/archetypes/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/pages/frontmatter-icon.png b/cont/frontmatter/frontmatter-icon.png similarity index 100% rename from cont/pages/frontmatter-icon.png rename to cont/frontmatter/frontmatter-icon.png diff --git a/cont/frontmatter/index.html b/cont/frontmatter/index.html new file mode 100644 index 0000000000..95047183b5 --- /dev/null +++ b/cont/frontmatter/index.html @@ -0,0 +1,708 @@ + + + + + + + + + + + + + + + + + + + + Frontmatter :: Hugo Relearn Theme + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+

Frontmatter

+ +

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

+
+++
+# If an option value is said to be not set, you can achieve the same behavior
+# by given it an empty string value.
+
+###############################################################################
+# Hugo
+# These options usually apply to other themes aswell.
+
+# The social media image of your page.
+# Default: not set
+# This is used for generating social media meta information for the opengraph
+# protocol and twitter cards.
+# If not set, the set value of your site's config.toml is used.
+images = [ "images/hero.png" ]
+
+# The title of your page.
+# Default: not set
+# A page without a title is treated as a hidden page.
+title = "Example Page"
+
+# The description of your page.
+# Default: not set
+# This is used for generating HTML meta tags, social media meta information
+# for the opengraph protocol and twitter cards.
+# If not set, the set value of your site's config.toml is used for the html
+# meta tag, social media meta information for the opengraph protocol and
+# twitter cards.
+description = ""
+
+###############################################################################
+# Relearn Theme
+# These options are specific to the Relearn theme.
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Topbar
+# These options modify the topbar appearance.
+
+# Hide the table of contents button.
+# Default: false
+# If the TOC button is hidden, also the keyboard shortcut is disabled.
+# If not set, the set value of your site's config.toml is used.
+disableToc = false
+
+# Hide the breadcrumbs.
+# Default: false
+# If the breadcrumbs are hidden, the title of the displayed page will still be
+# shown in the topbar.
+disableBreadcrumb = false
+
+# Hide Next and Previous navigation buttons.
+# Default: false
+# If the navigation buttons are hidden, also the keyboard shortcuts are
+# disabled.
+disableNextPrev = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Menu
+# These options modify the menu apperance.
+
+# The title in main menu.
+# Default: <title>
+# If set, this will be used for the page's menu entry instead of the `title`
+# option.
+menuTitle = ""
+
+# Prefix for the title in main menu.
+# Default: not set
+# The title of the page in the menu will be prefixed by this HTML content.
+menuPre = ""
+
+# Suffix for the title in main menu.
+# Default: not set
+# The title of the page in the menu will be suffixed by this HTML content.
+menuPost = ""
+
+# The order of main menu submenus.
+# Default: "weight"
+# Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",
+# "expirydate", "publishdate", "date", "length" or "default" (adhering to
+# Hugo's default sort order).
+# If not set, the value of the parent menu entry is used.
+ordersectionsby = "weight"
+
+# The initial expand state of submenus.
+# Default: not set
+# This controls whether submenus will be expanded (true), or collapsed (false)
+# in the menu. If not set, the first menu level is set to false, all others
+# levels are set to true. If not set, the value of the parent menu entry is used.
+# If the displayed page has submenus, they will always been displayed expanded
+# regardless of this option.
+alwaysopen = ""
+
+# Shows expander for submenus.
+# Default: false
+# If set to true, a submenu in the sidebar will be displayed in a collapsible
+# tree view and a clickable expander is set in front of the entry.
+collapsibleMenu = true
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Hidden pages
+# These options configure how hidden pages are treated.
+# A page flagged as hidden, is only removed from the main menu if you are
+# currently not on this page or the hidden page is not part of current page's
+# ancestors. For all other functionality in Hugo a hidden page behaves like any
+# other page if not otherwise configured.
+
+# Hide a page's menu entry.
+# Default: false
+# If this value is true, the page is hidden from the menu.
+hidden = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Content
+# These options modify how your content is displayed.
+
+# Prefix for the title in the content area.
+# Default: not set
+# The title of the page heading will be prefixed by this HTML content.
+headingPre = ""
+
+# Suffix for the title in the content area.
+# Default: not set
+# The title of the page heading will be suffixed by this HTML content.
+headingPost = ""
+
+# Display name of the page's last editor.
+# Default: not set
+# If set, it will be displayed in the default footer.
+LastModifierDisplayName = ""
+
+# Email address of the page's last editor.
+# Default: not set
+# If set together with LastModifierDisplayName, it will be displayed in the
+# default footer.
+LastModifierEmail = ""
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Highlight
+# These options configure how code is displayed.
+
+# Wrap for code blocks.
+# Default: true
+# By default lines of code blocks wrap around if the line is too long to be
+# displayed on screen. If you dislike this behavior, you can reconfigure it
+# here.
+# Note that lines always wrap in print mode regardless of this option.
+# If not set, the set value of your site's config.toml is used or given as a
+# parameter to individual code blocks.
+highlightWrap = true
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Images
+# These options configure how images are displayed.
+
+# Image effects.
+# See the documentation for how you can even add your own arbitrary effects to
+# the list.
+# All effect values default to the values of your site's config.toml and can be
+# overridden thru URL parameter given to the image. See the documentation for
+# details.
+
+# Default: false
+imageEffects.border = true
+# Default: true
+imageEffects.lightbox = true
+# Default: false
+imageEffects.shadow = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# MathJax
+# These options configure how math formulae are displayed.
+
+# Initialization options for MathJax.
+# Default: not set
+# A JSON value. See the MathJaxdocumentation for possible parameter.
+# If not set, the set value of your site's config.toml is used.
+mathJaxInitialize = "{}"
+
+# Only load MathJax if needed.
+# Default: true
+# If a Math shortcode is found, the option will be ignored and
+# MathJax will be loaded regardlessly. The option is still useful in case you
+# are using scripting to set up your graph. In this case no shortcode or
+# codefence is involved and the library is not loaded by default. In this case
+# you can set `disableMathJax=false` in your frontmatter to force the library to
+# be loaded.
+# If not set, the set value of your site's config.toml is used.
+disableMathJax = true
+
+# URL for external MathJax library.
+# Default: not set
+# Specifies the remote location of the MathJax library. By default the shipped
+# version will be used.
+# If not set, the set value of your site's config.toml is used.
+customMathJaxURL = "" # "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Mermaid
+# These options configure how Mermaid graphs are displayed.
+
+# Make graphs panable and zoomable
+# Default: false
+# For huge graphs it can be helpful to make them zoomable. Zoomable graphs come
+# with a reset button for the zoom.
+# If not set, the set value of your site's config.toml is used or given as a
+# parameter to individual graphs.
+mermaidZoom = true
+
+# Initialization options for Mermaid.
+# Default: not set
+# A JSON value. See the Mermaid documentation for possible parameter.
+# If not set, the set value of your site's config.toml is used.
+mermaidInitialize = "{ \"securityLevel\": \"loose\" }"
+
+# Only load Mermaid if needed.
+# Default: true
+# If a Mermaid shortcode or codefence is found, the option will be ignored and
+# Mermaid will be loaded regardlessly. The option is still useful in case you
+# are using scripting to set up your graph. In this case no shortcode or
+# codefence is involved and the library is not loaded by default. In this case
+# you can set `disableMermaid=false` in your frontmatter to force the library to
+# be loaded.
+# If not set, the set value of your site's config.toml is used.
+disableMermaid = true
+
+# URL for external Mermaid library.
+# Default: not set
+# Specifies the remote location of the Mermaid library. By default the shipped
+# version will be used.
+# If not set, the set value of your site's config.toml is used.
+customMermaidURL = "" # "https://unpkg.com/mermaid/dist/mermaid.min.js"
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# OpenApi
+# These options configure how OpenAPI specifications are displayed.
+
+# Only load OpenAPI if needed.
+# Default: true
+# If a OpenAPI shortcode is found, the option will be ignored and
+# OpenAPI will be loaded regardlessly. The option is still useful in case you
+# are using scripting to set up your graph. In this case no shortcode or
+# codefence is involved and the library is not loaded by default. In this case
+# you can set `disableOpenapi=false` in your frontmatter to force the library to
+# be loaded.
+# If not set, the set value of your site's config.toml is used.
+disableOpenapi = true
+
+# URL for external OpenAPI library.
+# Default: not set
+# Specifies the remote location of the OpenAPI library. By default the shipped
+# version will be used.
+# If not set, the set value of your site's config.toml is used.
+customOpenapiURL = "" # "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
++++

Some Detailed Examples

+

Add Icon to a Menu Entry

+

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

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

Title with icon +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

+

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

+

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:

+
    +
  • all parent entries of the active page including their siblings are shown regardless of any settings
    • +
  • immediate children entries of the active page are shown regardless of any settings
    • +
  • if not overridden, all other first level entries behave like they would have been given alwaysopen=false
    • +
  • if not overridden, all other entries of levels besides the first behave like they would have been given alwaysopen=true
    • +
  • all visible entries show their immediate children entries if alwaysopen=true; this proceeds recursively
    • +
  • all remaining entries are not shown
    • +
+

You can see this feature in action on the example page for children shortcode and its children pages.

+

Disable Section Pages

+

You may want to structure your pages in a hierachical way but don’t want to generate pages for those sections? The theme got you covered.

+

To stay with the initial example: Suppose you want level-one appear in the sidebar but don’t want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander.

+

For this, open content/level-one/_index.md and add the following frontmatter

+
+++
+collapsibleMenu = true # this adds the expander to the menu entry if not already set in your config.toml
+[_build]
+  render = "never" # no page will be generated so the page does not have a url
++++
+ +
+
+
+
+ + + + + + diff --git a/cont/frontmatter/index.print.html b/cont/frontmatter/index.print.html new file mode 100644 index 0000000000..7595dc3b40 --- /dev/null +++ b/cont/frontmatter/index.print.html @@ -0,0 +1,405 @@ + + + + + + + + + + + + + + + + + + + + Frontmatter :: Hugo Relearn Theme + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+

Frontmatter

+ +

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

+
+++
+# If an option value is said to be not set, you can achieve the same behavior
+# by given it an empty string value.
+
+###############################################################################
+# Hugo
+# These options usually apply to other themes aswell.
+
+# The social media image of your page.
+# Default: not set
+# This is used for generating social media meta information for the opengraph
+# protocol and twitter cards.
+# If not set, the set value of your site's config.toml is used.
+images = [ "images/hero.png" ]
+
+# The title of your page.
+# Default: not set
+# A page without a title is treated as a hidden page.
+title = "Example Page"
+
+# The description of your page.
+# Default: not set
+# This is used for generating HTML meta tags, social media meta information
+# for the opengraph protocol and twitter cards.
+# If not set, the set value of your site's config.toml is used for the html
+# meta tag, social media meta information for the opengraph protocol and
+# twitter cards.
+description = ""
+
+###############################################################################
+# Relearn Theme
+# These options are specific to the Relearn theme.
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Topbar
+# These options modify the topbar appearance.
+
+# Hide the table of contents button.
+# Default: false
+# If the TOC button is hidden, also the keyboard shortcut is disabled.
+# If not set, the set value of your site's config.toml is used.
+disableToc = false
+
+# Hide the breadcrumbs.
+# Default: false
+# If the breadcrumbs are hidden, the title of the displayed page will still be
+# shown in the topbar.
+disableBreadcrumb = false
+
+# Hide Next and Previous navigation buttons.
+# Default: false
+# If the navigation buttons are hidden, also the keyboard shortcuts are
+# disabled.
+disableNextPrev = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Menu
+# These options modify the menu apperance.
+
+# The title in main menu.
+# Default: <title>
+# If set, this will be used for the page's menu entry instead of the `title`
+# option.
+menuTitle = ""
+
+# Prefix for the title in main menu.
+# Default: not set
+# The title of the page in the menu will be prefixed by this HTML content.
+menuPre = ""
+
+# Suffix for the title in main menu.
+# Default: not set
+# The title of the page in the menu will be suffixed by this HTML content.
+menuPost = ""
+
+# The order of main menu submenus.
+# Default: "weight"
+# Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",
+# "expirydate", "publishdate", "date", "length" or "default" (adhering to
+# Hugo's default sort order).
+# If not set, the value of the parent menu entry is used.
+ordersectionsby = "weight"
+
+# The initial expand state of submenus.
+# Default: not set
+# This controls whether submenus will be expanded (true), or collapsed (false)
+# in the menu. If not set, the first menu level is set to false, all others
+# levels are set to true. If not set, the value of the parent menu entry is used.
+# If the displayed page has submenus, they will always been displayed expanded
+# regardless of this option.
+alwaysopen = ""
+
+# Shows expander for submenus.
+# Default: false
+# If set to true, a submenu in the sidebar will be displayed in a collapsible
+# tree view and a clickable expander is set in front of the entry.
+collapsibleMenu = true
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Hidden pages
+# These options configure how hidden pages are treated.
+# A page flagged as hidden, is only removed from the main menu if you are
+# currently not on this page or the hidden page is not part of current page's
+# ancestors. For all other functionality in Hugo a hidden page behaves like any
+# other page if not otherwise configured.
+
+# Hide a page's menu entry.
+# Default: false
+# If this value is true, the page is hidden from the menu.
+hidden = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Content
+# These options modify how your content is displayed.
+
+# Prefix for the title in the content area.
+# Default: not set
+# The title of the page heading will be prefixed by this HTML content.
+headingPre = ""
+
+# Suffix for the title in the content area.
+# Default: not set
+# The title of the page heading will be suffixed by this HTML content.
+headingPost = ""
+
+# Display name of the page's last editor.
+# Default: not set
+# If set, it will be displayed in the default footer.
+LastModifierDisplayName = ""
+
+# Email address of the page's last editor.
+# Default: not set
+# If set together with LastModifierDisplayName, it will be displayed in the
+# default footer.
+LastModifierEmail = ""
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Highlight
+# These options configure how code is displayed.
+
+# Wrap for code blocks.
+# Default: true
+# By default lines of code blocks wrap around if the line is too long to be
+# displayed on screen. If you dislike this behavior, you can reconfigure it
+# here.
+# Note that lines always wrap in print mode regardless of this option.
+# If not set, the set value of your site's config.toml is used or given as a
+# parameter to individual code blocks.
+highlightWrap = true
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Images
+# These options configure how images are displayed.
+
+# Image effects.
+# See the documentation for how you can even add your own arbitrary effects to
+# the list.
+# All effect values default to the values of your site's config.toml and can be
+# overridden thru URL parameter given to the image. See the documentation for
+# details.
+
+# Default: false
+imageEffects.border = true
+# Default: true
+imageEffects.lightbox = true
+# Default: false
+imageEffects.shadow = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# MathJax
+# These options configure how math formulae are displayed.
+
+# Initialization options for MathJax.
+# Default: not set
+# A JSON value. See the MathJaxdocumentation for possible parameter.
+# If not set, the set value of your site's config.toml is used.
+mathJaxInitialize = "{}"
+
+# Only load MathJax if needed.
+# Default: true
+# If a Math shortcode is found, the option will be ignored and
+# MathJax will be loaded regardlessly. The option is still useful in case you
+# are using scripting to set up your graph. In this case no shortcode or
+# codefence is involved and the library is not loaded by default. In this case
+# you can set `disableMathJax=false` in your frontmatter to force the library to
+# be loaded.
+# If not set, the set value of your site's config.toml is used.
+disableMathJax = true
+
+# URL for external MathJax library.
+# Default: not set
+# Specifies the remote location of the MathJax library. By default the shipped
+# version will be used.
+# If not set, the set value of your site's config.toml is used.
+customMathJaxURL = "" # "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Mermaid
+# These options configure how Mermaid graphs are displayed.
+
+# Make graphs panable and zoomable
+# Default: false
+# For huge graphs it can be helpful to make them zoomable. Zoomable graphs come
+# with a reset button for the zoom.
+# If not set, the set value of your site's config.toml is used or given as a
+# parameter to individual graphs.
+mermaidZoom = true
+
+# Initialization options for Mermaid.
+# Default: not set
+# A JSON value. See the Mermaid documentation for possible parameter.
+# If not set, the set value of your site's config.toml is used.
+mermaidInitialize = "{ \"securityLevel\": \"loose\" }"
+
+# Only load Mermaid if needed.
+# Default: true
+# If a Mermaid shortcode or codefence is found, the option will be ignored and
+# Mermaid will be loaded regardlessly. The option is still useful in case you
+# are using scripting to set up your graph. In this case no shortcode or
+# codefence is involved and the library is not loaded by default. In this case
+# you can set `disableMermaid=false` in your frontmatter to force the library to
+# be loaded.
+# If not set, the set value of your site's config.toml is used.
+disableMermaid = true
+
+# URL for external Mermaid library.
+# Default: not set
+# Specifies the remote location of the Mermaid library. By default the shipped
+# version will be used.
+# If not set, the set value of your site's config.toml is used.
+customMermaidURL = "" # "https://unpkg.com/mermaid/dist/mermaid.min.js"
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# OpenApi
+# These options configure how OpenAPI specifications are displayed.
+
+# Only load OpenAPI if needed.
+# Default: true
+# If a OpenAPI shortcode is found, the option will be ignored and
+# OpenAPI will be loaded regardlessly. The option is still useful in case you
+# are using scripting to set up your graph. In this case no shortcode or
+# codefence is involved and the library is not loaded by default. In this case
+# you can set `disableOpenapi=false` in your frontmatter to force the library to
+# be loaded.
+# If not set, the set value of your site's config.toml is used.
+disableOpenapi = true
+
+# URL for external OpenAPI library.
+# Default: not set
+# Specifies the remote location of the OpenAPI library. By default the shipped
+# version will be used.
+# If not set, the set value of your site's config.toml is used.
+customOpenapiURL = "" # "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
++++

Some Detailed Examples

+

Add Icon to a Menu Entry

+

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

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

Title with icon +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

+

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

+

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:

+
    +
  • all parent entries of the active page including their siblings are shown regardless of any settings
    • +
  • immediate children entries of the active page are shown regardless of any settings
    • +
  • if not overridden, all other first level entries behave like they would have been given alwaysopen=false
    • +
  • if not overridden, all other entries of levels besides the first behave like they would have been given alwaysopen=true
    • +
  • all visible entries show their immediate children entries if alwaysopen=true; this proceeds recursively
    • +
  • all remaining entries are not shown
    • +
+

You can see this feature in action on the example page for children shortcode and its children pages.

+

Disable Section Pages

+

You may want to structure your pages in a hierachical way but don’t want to generate pages for those sections? The theme got you covered.

+

To stay with the initial example: Suppose you want level-one appear in the sidebar but don’t want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander.

+

For this, open content/level-one/_index.md and add the following frontmatter

+
+++
+collapsibleMenu = true # this adds the expander to the menu entry if not already set in your config.toml
+[_build]
+  render = "never" # no page will be generated so the page does not have a url
++++
+ +
+ +
+
+
+ + + + + diff --git a/cont/frontmatter/index.xml b/cont/frontmatter/index.xml new file mode 100644 index 0000000000..10187b2f58 --- /dev/null +++ b/cont/frontmatter/index.xml @@ -0,0 +1,11 @@ + + + + Frontmatter on Hugo Relearn Theme + https://McShelby.github.io/hugo-theme-relearn/cont/frontmatter/index.html + Recent content in Frontmatter on Hugo Relearn Theme + Hugo -- gohugo.io + en + + + \ No newline at end of file diff --git a/cont/i18n/index.html b/cont/i18n/index.html index 180577f072..8952515f89 100644 --- a/cont/i18n/index.html +++ b/cont/i18n/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/i18n/index.print.html b/cont/i18n/index.print.html index ad1f45b7bd..45469511e1 100644 --- a/cont/i18n/index.print.html +++ b/cont/i18n/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/imageeffects/index.html b/cont/imageeffects/index.html index db6d79eb58..375403e5ea 100644 --- a/cont/imageeffects/index.html +++ b/cont/imageeffects/index.html @@ -32,21 +32,21 @@ Without any settings in your config.toml this defaults to"> - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/imageeffects/index.print.html b/cont/imageeffects/index.print.html index 913095e110..399f82ef9a 100644 --- a/cont/imageeffects/index.print.html +++ b/cont/imageeffects/index.print.html @@ -32,22 +32,22 @@ Without any settings in your config.toml this defaults to"> - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/index.html b/cont/index.html index c959b90683..b8fce7ae45 100644 --- a/cont/index.html +++ b/cont/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/index.print.html b/cont/index.print.html index 6e5a8b45d5..35410a198c 100644 --- a/cont/index.print.html +++ b/cont/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/index.xml b/cont/index.xml index fbe361d48d..ed9d72e123 100644 --- a/cont/index.xml +++ b/cont/index.xml @@ -15,6 +15,14 @@ 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 &lt;-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a. + + + Frontmatter + https://McShelby.github.io/hugo-theme-relearn/cont/frontmatter/index.html + Mon, 01 Jan 0001 00:00:00 +0000 + https://McShelby.github.io/hugo-theme-relearn/cont/frontmatter/index.html + Each Hugo page has to define a frontmatter in toml, yaml or json. This site will use toml for documentation in all cases. ++++ # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes aswell. # The social media image of your page. # Default: not set # This is used for generating social media meta information for the opengraph # protocol and twitter cards. Archetypes diff --git a/cont/markdown/index.html b/cont/markdown/index.html index 0c3c28eee6..5575810186 100644 --- a/cont/markdown/index.html +++ b/cont/markdown/index.html @@ -30,21 +30,21 @@ Markdown is simple to learn, with minimal extra characters so it’s also qu - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/markdown/index.print.html b/cont/markdown/index.print.html index 0231e98493..43a4495c6c 100644 --- a/cont/markdown/index.print.html +++ b/cont/markdown/index.print.html @@ -30,22 +30,22 @@ Markdown is simple to learn, with minimal extra characters so it’s also qu - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/menushortcuts/index.html b/cont/menushortcuts/index.html index f9bf1af6ed..81b2f83acf 100644 --- a/cont/menushortcuts/index.html +++ b/cont/menushortcuts/index.html @@ -30,21 +30,21 @@ Example from the current website: - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/menushortcuts/index.print.html b/cont/menushortcuts/index.print.html index 53036df650..d6588ab62a 100644 --- a/cont/menushortcuts/index.print.html +++ b/cont/menushortcuts/index.print.html @@ -30,22 +30,22 @@ Example from the current website: - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/pages/index.html b/cont/pages/index.html index d0d5bafe8a..e4570310e2 100644 --- a/cont/pages/index.html +++ b/cont/pages/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/pages/index.print.html b/cont/pages/index.print.html index 50e565a0ac..626bc0bcbd 100644 --- a/cont/pages/index.print.html +++ b/cont/pages/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/cont/taxonomy/index.html b/cont/taxonomy/index.html index 667afafcd0..10e97aa694 100644 --- a/cont/taxonomy/index.html +++ b/cont/taxonomy/index.html @@ -30,21 +30,21 @@ The categories are displayed at the bottom of the page in alphabetical order in - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/cont/taxonomy/index.print.html b/cont/taxonomy/index.print.html index dacc371558..741b15dd96 100644 --- a/cont/taxonomy/index.print.html +++ b/cont/taxonomy/index.print.html @@ -30,22 +30,22 @@ The categories are displayed at the bottom of the page in alphabetical order in - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/dev/contributing/index.html b/dev/contributing/index.html index dcedbd7268..100db4a4f0 100644 --- a/dev/contributing/index.html +++ b/dev/contributing/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/contributing/index.print.html b/dev/contributing/index.print.html index 560c0d9432..53584e4b4d 100644 --- a/dev/contributing/index.print.html +++ b/dev/contributing/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/dev/index.html b/dev/index.html index 5784e74fdd..3f4230aaa9 100644 --- a/dev/index.html +++ b/dev/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/index.print.html b/dev/index.print.html index 62d6647ba7..5030127ba4 100644 --- a/dev/index.print.html +++ b/dev/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/dev/maintaining/index.html b/dev/maintaining/index.html index 0b4671712c..a8cc949af1 100644 --- a/dev/maintaining/index.html +++ b/dev/maintaining/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/maintaining/index.print.html b/dev/maintaining/index.print.html index 92c67cf1a9..a343a85ec2 100644 --- a/dev/maintaining/index.print.html +++ b/dev/maintaining/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/dev/screenshots/index.html b/dev/screenshots/index.html index 93ba39562d..a87bc08d82 100644 --- a/dev/screenshots/index.html +++ b/dev/screenshots/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/dev/screenshots/index.print.html b/dev/screenshots/index.print.html index fb2730dca8..71b9f57a1c 100644 --- a/dev/screenshots/index.print.html +++ b/dev/screenshots/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/en/sitemap.xml b/en/sitemap.xml index c4146075db..9d1e206a86 100644 --- a/en/sitemap.xml +++ b/en/sitemap.xml @@ -18,18 +18,18 @@ - - https://McShelby.github.io/hugo-theme-relearn/cont/archetypes/index.html - - - - https://McShelby.github.io/hugo-theme-relearn/cont/index.html + + https://McShelby.github.io/hugo-theme-relearn/cont/frontmatter/index.html + + + + https://McShelby.github.io/hugo-theme-relearn/basics/migration/index.html @@ -37,10 +37,10 @@ - https://McShelby.github.io/hugo-theme-relearn/cont/markdown/index.html - - - + https://McShelby.github.io/hugo-theme-relearn/cont/archetypes/index.html + + + https://McShelby.github.io/hugo-theme-relearn/shortcodes/index.html @@ -48,6 +48,12 @@ + + https://McShelby.github.io/hugo-theme-relearn/cont/markdown/index.html + + + + https://McShelby.github.io/hugo-theme-relearn/cont/imageeffects/index.html diff --git a/index.html b/index.html index f33eea11e9..28b4ad4228 100644 --- a/index.html +++ b/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/index.print.html b/index.print.html index 3f0f6c9978..0197bb1a20 100644 --- a/index.print.html +++ b/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/index.search.js b/index.search.js index ddd5eff614..c8165f1b15 100644 --- a/index.search.js +++ b/index.search.js @@ -19,20 +19,12 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "content": "In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.\nFolders Organize your site like any other Hugo project. Typically, you will have a content folder with all your pages.\ncontent ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Note _index.md is required in each folder, it’s your “folder home page”\nCreate your project 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 great documentation for beginners.\nHugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003eThe Relearn theme provides archetypes to help you create this kind of pages.\nFrontmatter Configuration Each Hugo page has to define a frontmatter in toml, yaml or json. This site will use toml in all cases.\nThe Relearn theme uses the following parameters on top of Hugo ones:\n+++ # Table of contents (toc) is enabled by default. Set this parameter to true to disable it. # Note: Toc is always disabled for chapter pages disableToc = false # If set, this will be used for the page's menu entry (instead of the `title` attribute) menuTitle = \"\" # If set to true, the menu in the sidebar will be displayed in a collapsible tree view. Although the functionality works with old browsers (IE11), the display of the expander icons is limited to modern browsers collapsibleMenu = false # 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 = \"weight\" # The title of the page heading will be prefixed by this HTML content headingPre = \"\" # The title of the page heading will be postfixed by this HTML content headingPost = \"\" # The title of the page in menu will be prefixed by this HTML content menuPre = \"\" # The title of the page in menu will be postfixed by this HTML content menuPost = \"\" # 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 = \"\" # Override default values for image effects, you can even add your own arbitrary effects to the list [params.imageEffects] border = false lightbox = true shadow = false +++Add icon to a menu entry In the page frontmatter, add a menuPre param to insert any HTML code before the menu label. The example below uses the GitHub icon.\n+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Ordering sibling menu/page entries Hugo provides a flexible way to handle order for your pages.\nThe simplest way is to set weight parameter to a number.\n+++ 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).\nBut 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:\nFor example (for a page named content/install/linux.md):\n+++ 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.\nThe theme generates the menu based on the following rules:\nall parent entries of the active page including their siblings are shown regardless of any settings immediate children entries of the active page are shown regardless of any settings if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries of levels besides the first behave like they would have been given alwaysopen=true all visible entries show their immediate children entries if alwaysopen=true; this proceeds recursively all remaining entries are not shown You can see this feature in action on the example page for children shortcode and its children pages.\nDisable Section Pages You may want to structure your pages in a hierachical way but don’t want to generate pages for those sections? The theme got you covered.\nTo stay with the initial example: Suppose you want level-one appear in the sidebar but don’t want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander.\nFor this, open content/level-one/_index.md and add the following frontmatter\ncollapsibleMenu = true # this adds the expander to the menu entry if not already set in your config.toml [_build] render = \"never\" # no page will be generated so the page does not have a url", + "content": "In Hugo, pages are the core of your site. Once it is configured, pages are definitely the added value to your documentation site.\nFolders Organize your site like any other Hugo project. Typically, you will have a content folder with all your pages.\ncontent ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Note _index.md is required in each folder, it’s your “folder home page”\nCreate your project 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 great documentation for beginners.\nHugo provides a new command to create a new website.\nhugo new site \u003cnew_project\u003eThe Relearn theme provides archetypes to help you create this kind of pages.\n", "description": "", "tags": null, "title": "Pages organization", "uri": "/cont/pages/index.html" }, - { - "breadcrumb": "Content", - "content": "Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: archetypes. These are preconfigured skeleton pages with default frontmatter.\nThe Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.\nPredefined Archetypes Home A Home page is the starting page of your project. It’s best to have only one page of this kind in your project.\nTo create a home page, run the following command\nhugo new --kind home _index.mdThis leads to a file with the following content\n+++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum.Chapter 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 below it.\nTo create a chapter page, run the following command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads to a file with the following content\n+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace the X with a number. Because this number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.\nDefault A Default page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.\nTo create a default page, run either one of the following commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads to a file with the following content\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace the X with a number or delete the whole weight parameter entirely.\nSelf defined Archetypes If you are in need of further archetypes you can define your own or even redefine existing ones.\nTemplate Define a template file in your project at archetypes/\u003ckind\u003e.md and make sure it has at least the frontmatter parameter for that archetype like\n+++ archetype = \"\u003ckind\u003e\" +++Afterwards you can generate new content files of that kind with the following command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials To define how your archetypes are rendered, define corresponding partial files in your projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf you use an unknown archetype in your frontmatter, the default archetype will be used to generate the page.\nRelated to each archetype, several hook partial files in the form of \u003chook\u003e.html can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.\nThe following hooks are used:\nName Notes styleclass Defines a set of CSS classes to be added to the HTML’s \u003cmain\u003e element. You can use these classes to define own CSS rules in your custom-header.html article Defines the HTML how to render your content Take a look at the existing archetypes of this theme to get an idea how to utilize it.\nOutput formats Each hook file can be overridden of a specific output format. Eg. if you define a new output format PLAINTEXT in your config.toml, you can add a file layouts/partials/archetypes/default.plaintext.html to change the way how normal content is written for that output format.\n", - "description": "", - "tags": null, - "title": "Archetypes", - "uri": "/cont/archetypes/index.html" - }, { "breadcrumb": "", "content": "Find out how to create and organize your content quickly and intuitively.\n", @@ -41,6 +33,14 @@ var relearn_search_index = [ "title": "Content", "uri": "/cont/index.html" }, + { + "breadcrumb": "Content", + "content": "Each Hugo page has to define a frontmatter in toml, yaml or json. This site will use toml for documentation in all cases.\n+++ # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes aswell. # The social media image of your page. # Default: not set # This is used for generating social media meta information for the opengraph # protocol and twitter cards. # If not set, the set value of your site's config.toml is used. images = [ \"images/hero.png\" ] # The title of your page. # Default: not set # A page without a title is treated as a hidden page. title = \"Example Page\" # The description of your page. # Default: not set # This is used for generating HTML meta tags, social media meta information # for the opengraph protocol and twitter cards. # If not set, the set value of your site's config.toml is used for the html # meta tag, social media meta information for the opengraph protocol and # twitter cards. description = \"\" ############################################################################### # Relearn Theme # These options are specific to the Relearn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These options modify the topbar appearance. # Hide the table of contents button. # Default: false # If the TOC button is hidden, also the keyboard shortcut is disabled. # If not set, the set value of your site's config.toml is used. disableToc = false # Hide the breadcrumbs. # Default: false # If the breadcrumbs are hidden, the title of the displayed page will still be # shown in the topbar. disableBreadcrumb = false # Hide Next and Previous navigation buttons. # Default: false # If the navigation buttons are hidden, also the keyboard shortcuts are # disabled. disableNextPrev = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu apperance. # The title in main menu. # Default: \u003ctitle\u003e # If set, this will be used for the page's menu entry instead of the `title` # option. menuTitle = \"\" # Prefix for the title in main menu. # Default: not set # The title of the page in the menu will be prefixed by this HTML content. menuPre = \"\" # Suffix for the title in main menu. # Default: not set # The title of the page in the menu will be suffixed by this HTML content. menuPost = \"\" # The order of main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adhering to # Hugo's default sort order). # If not set, the value of the parent menu entry is used. ordersectionsby = \"weight\" # The initial expand state of submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # in the menu. If not set, the first menu level is set to false, all others # levels are set to true. If not set, the value of the parent menu entry is used. # If the displayed page has submenus, they will always been displayed expanded # regardless of this option. alwaysopen = \"\" # Shows expander for submenus. # Default: false # If set to true, a submenu in the sidebar will be displayed in a collapsible # tree view and a clickable expander is set in front of the entry. collapsibleMenu = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden pages # These options configure how hidden pages are treated. # A page flagged as hidden, is only removed from the main menu if you are # currently not on this page or the hidden page is not part of current page's # ancestors. For all other functionality in Hugo a hidden page behaves like any # other page if not otherwise configured. # Hide a page's menu entry. # Default: false # If this value is true, the page is hidden from the menu. hidden = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Content # These options modify how your content is displayed. # Prefix for the title in the content area. # Default: not set # The title of the page heading will be prefixed by this HTML content. headingPre = \"\" # Suffix for the title in the content area. # Default: not set # The title of the page heading will be suffixed by this HTML content. headingPost = \"\" # Display name of the page's last editor. # Default: not set # If set, it will be displayed in the default footer. LastModifierDisplayName = \"\" # Email address of the page's last editor. # Default: not set # If set together with LastModifierDisplayName, it will be displayed in the # default footer. LastModifierEmail = \"\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These options configure how code is displayed. # Wrap for code blocks. # Default: true # By default lines of code blocks wrap around if the line is too long to be # displayed on screen. If you dislike this behavior, you can reconfigure it # here. # Note that lines always wrap in print mode regardless of this option. # If not set, the set value of your site's config.toml is used or given as a # parameter to individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These options configure how images are displayed. # Image effects. # See the documentation for how you can even add your own arbitrary effects to # the list. # All effect values default to the values of your site's config.toml and can be # overridden thru URL parameter given to the image. See the documentation for # details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These options configure how math formulae are displayed. # Initialization options for MathJax. # Default: not set # A JSON value. See the MathJaxdocumentation for possible parameter. # If not set, the set value of your site's config.toml is used. mathJaxInitialize = \"{}\" # Only load MathJax if needed. # Default: true # If a Math shortcode is found, the option will be ignored and # MathJax will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMathJax=false` in your frontmatter to force the library to # be loaded. # If not set, the set value of your site's config.toml is used. disableMathJax = true # URL for external MathJax library. # Default: not set # Specifies the remote location of the MathJax library. By default the shipped # version will be used. # If not set, the set value of your site's config.toml is used. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Mermaid # These options configure how Mermaid graphs are displayed. # Make graphs panable and zoomable # Default: false # For huge graphs it can be helpful to make them zoomable. Zoomable graphs come # with a reset button for the zoom. # If not set, the set value of your site's config.toml is used or given as a # parameter to individual graphs. mermaidZoom = true # Initialization options for Mermaid. # Default: not set # A JSON value. See the Mermaid documentation for possible parameter. # If not set, the set value of your site's config.toml is used. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only load Mermaid if needed. # Default: true # If a Mermaid shortcode or codefence is found, the option will be ignored and # Mermaid will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMermaid=false` in your frontmatter to force the library to # be loaded. # If not set, the set value of your site's config.toml is used. disableMermaid = true # URL for external Mermaid library. # Default: not set # Specifies the remote location of the Mermaid library. By default the shipped # version will be used. # If not set, the set value of your site's config.toml is used. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These options configure how OpenAPI specifications are displayed. # Only load OpenAPI if needed. # Default: true # If a OpenAPI shortcode is found, the option will be ignored and # OpenAPI will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableOpenapi=false` in your frontmatter to force the library to # be loaded. # If not set, the set value of your site's config.toml is used. disableOpenapi = true # URL for external OpenAPI library. # Default: not set # Specifies the remote location of the OpenAPI library. By default the shipped # version will be used. # If not set, the set value of your site's config.toml is used. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" +++Some Detailed Examples Add Icon to a Menu Entry In the page frontmatter, add a menuPre param to insert any HTML code before the menu label. The example below uses the GitHub icon.\n+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Ordering Sibling Menu/Page Entries Hugo provides a flexible way to handle order for your pages.\nThe simplest way is to set weight parameter to a number.\n+++ 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).\nBut 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:\nFor example (for a page named content/install/linux.md):\n+++ 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.\nThe theme generates the menu based on the following rules:\nall parent entries of the active page including their siblings are shown regardless of any settings immediate children entries of the active page are shown regardless of any settings if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries of levels besides the first behave like they would have been given alwaysopen=true all visible entries show their immediate children entries if alwaysopen=true; this proceeds recursively all remaining entries are not shown You can see this feature in action on the example page for children shortcode and its children pages.\nDisable Section Pages You may want to structure your pages in a hierachical way but don’t want to generate pages for those sections? The theme got you covered.\nTo stay with the initial example: Suppose you want level-one appear in the sidebar but don’t want to generate a page for it. So the entry in the sidebar should not be clickable but should show an expander.\nFor this, open content/level-one/_index.md and add the following frontmatter\n+++ collapsibleMenu = true # this adds the expander to the menu entry if not already set in your config.toml [_build] render = \"never\" # no page will be generated so the page does not have a url +++", + "description": "", + "tags": null, + "title": "Frontmatter", + "uri": "/cont/frontmatter/index.html" + }, { "breadcrumb": "Basics", "content": "This document shows you what’s new in the latest release and flags it with one of the following badges. For a detailed list of changes, see the history page.\n0.112.4 The minimum required Hugo version.\nBreaking A change that requires action by you after upgrading to assure the site is still functional.\nChange A change in default behavior that may requires action by you if you want to revert it.\nNew Marks new behavior you might find interesting or comes configurable.\n5.24.0.beta 0.112.4 This release requires a newer Hugo version.\nChange The light themes have a bit more contrast for content text and headings. Also the syntaxhighlighting was changed to the more colorful MonokaiLight. This brings the syntaxhighlightning in sync with the corresponding dark theme variants, which are using Monokai. If you dislike this, you can create your own color variant file as described here.\nNew You now can configure additional options for every theme variant in your config.toml. This allows for optional advanced functionality. You don’t need to change anything as the old configuration options will still work (but may generate warnings now).\nThe advanced functionality allows you to set an explicit name for a theme variant, set different colors (if you are using monochrome SVGs) or even different icons (handy if you want to adjust colors for PNGs, GIFs or JPGs) and now allows for multiple auto mode variants that adjust to the light/dark preference of your OS settings.\n5.23.0 (2023-11-03) Change With 0.120.0 the author settings move into the [params] array in your config.toml. Because this collides with the previous way, the theme expected author information, it now adheres to Hugo standards and prints out a warning during built if something is wrong.\nChange your previous setting from\n[params] author = \"Hugo\"to\n[params] author.name = \"Hugo\" Change Taxonomy term pages now add the breadcrumb for each listed page. If this gets too crowded for you, you can turn the breadcrumbs off in your config.toml by adding disableTermBreadcrumbs=true.\nNew Taxonomy and term pages are now allowed to contain content. This is added inbetween the title and the page list.\nNew It is now possible to print custom taxonomies anywhere in your page. See the docs.\nNew It is now possible to adjust the menu width for your whole site. See the docs.\nNew This release adds social media meta tags for the Open Graph protocol and Twitter Cards to your site. See the docs.\nNew This release comes with additional sort options for the menu and the children shortcode. Both will now accept the following values: weight, title, linktitle, modifieddate, expirydate, publishdate, date, length or default (adhering to Hugo’s default sort order).\nNew The theme now provides a mechanism to load further JavaScript dependencies defined by you only if it is needed. This comes in handy if you want to add own shortcodes that depend on additional JavaScript code to be loaded. See the docs.\nNew The theme has updated its Mermaid dependency to 10.6.0. This adds support for the xychart type.\nNew This release adds portable Markdown links.\nPreviously it was not possible to use pure Markdown links in a configuration independend way to link to pages inside of your project. It always required you to know how your uglyURLs setting is, wheather you link to a page or page bundle and in case of relative links if your current page is a page or page bundle. (eg. [generator](generator/index.html) vs. [generator](generator.html)). This is a hassle as you have to change these links manually once you change your uglyURLs setting or change the type of a page.\nYou could work around this by using the relref shortcode (eg [generator]({{% relref \"../generator\" %}})) which works but results in non-portable Markdown.\nNow it’s possible to use the same path of a call to relref in a plain Markdown link (eg [generator](../generator)). This is independend of any configuration settings or the page types involved in linking. Note, that this requires your links to be given without any extension, so [generator](generator/index.html) will work as before.\nThe following types of linking are supported:\nlink description [generator](en/basics/generator) absolute from your project root (multilang) [generator](/en/basics/generator) absolute from your project root (multilang) [generator](basics/generator) absolute from your current language root [generator](/basics/generator) absolute from your current language root [generator](./../generator) relative from the current page [generator](../generator) relative from the current page 5.22.0 (2023-10-02) Change This release fixes an issue where in unfortunate conditions DOM ids generated by Hugo may collide with DOM ids set by the theme. To avoid this, all theme DOM ids are now prefixed with R-.\nIf you haven’t modified anything, everything is fine. Otherwise you have to check your custom CSS rules and JavaScript code.\nChange You can now have structural sections in the hierarchical menu without generating a page for it.\nThis can come in handy, if content for such a section page doesn’t make much sense to you. See the documentation for how to do this.\nThis feature may require you to make changes to your existing installation if you are already using shortcuts to pages inside of your project with a headless branch parent.\nIn this case it is advised to remove the title from the headless branch parent’s frontmatter, as it will otherwise appear in your breadcrumbs.\nNew It is now possible to overwrite the setting for collapsibleMenu of your config.toml inside of a page’s frontmatter.\nNew If a Mermaid graph is zoomable a button to reset the view is now added to the upper right corner. The button is only shown once the mouse is moved over the graph.\nNew It is now possible to remove the root breadcrumb by setting disableRootBreadcrumb=true in your config.toml.\nNew The output of the dedicated search page now displays the result’s breadcrumb.\nNew Table rows now change their background color on every even row.\nNew Translation into Swahili. This language is not supported for search.\n5.21.0 (2023-09-18) Change We made changes to the menu footer to improve alignment with the menu items in most cases. Care was taken not to break your existing overwritten footer. Anyways, if you have your menu-footer.html partial overridden, you may want to review the styling (eg. margins/paddings) of your partial.\nNew This release comes with an awesome new feature, that allows you to customize your topbar buttons, change behavior, reorder them or define entirely new ones, unique to your installation. See the documentation for further details.\nNew The theme has updated its Swagger dependency to 5.7.2 for the openapi shortcode. This brings support for OpenAPI Specification 3.1.\n5.20.0 (2023-08-26) Change The theme has updated its Swagger dependency to 5.4.1 for the openapi shortcode.\nWith this comes a change in the light theme variants of Relearn Bright, Relearn Light and Zen Light by switching the syntaxhighlightning inside of openapi to a light scheme. This brings it more in sync with the code style used by the theme variants itself.\nAdditionally, the syntaxhighlightning inside of openapi for printing was switched to a light scheme for all theme variants.\nIf you dislike this change, you can revert this in your theme variants CSS by adding\n--OPENAPI-CODE-theme: obsidian; --PRINT-OPENAPI-CODE-theme: obsidian; Change For consistency reasons, we renamed the CSS variable --MENU-SECTION-HR-color to --MENU-SECTION-SEPARATOR-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew The theme variants Zen Light and Zen Dark now add more contrast between menu, topbar and content by adding thin borders.\nThose borders are now configurable by using the CSS variables --MAIN-TOPBAR-BORDER-color, --MENU-BORDER-color, --MENU-TOPBAR-BORDER-color, --MENU-TOPBAR-SEPARATOR-color, --MENU-HEADER-SEPARATOR-color and --MENU-SECTION-ACTIVE-CATEGORY-BORDER-color.\nFor existing variants nothing has changed visually.\nNew The default values for the image effects are now configurable for your whole site via config.toml or for each page thru frontmatter.\nNew This release fixes a long outstanding bug where Mermaid graphs could not be displayed if they were initially hidden - like in collapsed expand or inactive tabs.\nNew Restored compatibility with Hugo versions lower than 0.111.0 for the highlight shortcode. This does not change the minimum required Hugo version.\n5.19.0 (2023-08-12) New The highlight shortcode now accepts the new parameter title. This displays the code like a single tab. This is also available using codefences and makes it much easier to write nicer code samples.\nNew The theme has added two new color variants zen-light and zen-dark. Check it out!\nNew The theme now dispatches the custom event themeVariantLoaded on the document when the variant is fully loaded either initially or by switching the variant manually with the variant selector.\nNew The theme has updated its Mermaid dependency to 10.3.1. This adds support for the sankey diagram type and now comes with full support for YAML inside Mermaid graphs (previously, the theme ignored explicit Mermaid theme settings in YAML).\nNew Translation into Hungarian.\n5.18.0 (2023-07-27) Change The theme adds additional warnings for deprecated or now unsupported features.\nChange There are visual improvements in displaying text links in your content aswell as to some other clickable areas in the theme. If you’ve overwritten some theme styles in your own CSS, keep this in mind.\nNew Restored compatibility with Hugo 0.95.0 or higher. This does not change the minimum required Hugo version.\nNew The siteparam shortcode is now capable in displaying nested params aswell as supporting text formatting.\n5.17.0 (2023-06-22) Change The default behavior for the copy-to-clipboard feature for code blocks has changed.\nThe copy-to-clipboard button for code blocks will now only be displayed if the reader hovers the code block.\nIf you dislike this new behavior you can turn it off and revert to the old behavior by adding [params] disableHoverBlockCopyToClipBoard=true to your config.toml.\nNew Restored compatibility with Hugo 0.114.0 or higher. This does not change the minimum required Hugo version.\nNew The new highlight shortcode replaces Hugo’s default implementation and is fully compatible. So you don’t need to change anything.\nIn addition it offers some extensions. Currently only the wrap extension option is provided to control whether a code block should be wrapped or scrolled if to long to fit.\n5.16.0 (2023-06-10) Change The theme now provides warnings for deprecated or now unsupported features. The warnings include hints how to fix them and an additional link to the documenation.\nDEPRECATION warnings mark features that still work but may be removed in the future.\nUNSUPPORTED warnings mark features that will not work anymore.\nChange The 404 error page was revamped. Hopefully you will not see this very often.\nNew The tabs shortcode and the tab shortcode received some love and now align with their style, color, title and icon parameter to the other shortcodes.\nThe visuals are now slightly different compared to previous versions. Most noteable, if you now display a single code block in a tab, its default styling will adapt to that of a code block but with a tab handle at the top.\nAdditionally the name parameter was renamed to title but you don’t need to change anything yet as the old name will be used as a fallback. Nevertheless you will get deprecation warnings while executing Hugo.\nNew The theme now optionally supports separate favicons for light \u0026 dark mode.\n5.15.0 (2023-05-29) Change Restored compatibility with Hugo 0.112.0 or higher. This does not change the minimum required Hugo version.\nThe attachments shortcode has compatiblity issues with newer Hugo versions. You must switch to leaf bundles or are locked to Hugo \u003c 0.112.0 for now.\nIt is planned to refactor the attchments shortcode in the future. This will make it possible to use the shortcode in branch bundles again but not in simple pages anymore. This will most likely come with a breaking change.\nChange The tabs shortcode has changed behavior if you haven’t set the groupid parameter.\nFormerly all tab views without a groupid were treated as so they belong to the same group. Now, each tab view is treated as it was given a unique id.\nNew The already known tabshas a new friend the tab shortcode to make it easier to create a tab view in case you only need one single tab. Really handy if you want to flag your code examples with a language identifier.\nAdditionally for such a use case, the whitespace between a tab outline and the code is removed if only a single code block is contained.\nNew Besides the tag taxonomy the theme now also provides the category taxonomy out of the box and shows them in the content footer of each page.\n5.14.0 (2023-05-20) New The taxonomy pages received some love in this release, making them better leverage available screen space and adding translation support for the taxonomy names.\nHugo’s default taxonmies tags and categories are already contained in the theme’s i18n files. If you have self-defined taxonomies, you can add translations by adding them to your own i18n files. If you don’t provide translations, the singualar and plural forms are taken as configured in your config.toml.\nNew To give you more flexibility in customizing your article layout a new partial content-header.html is introduced.\nThis came out of the requirement to customize the position of article tags, which by default are displayed above the title. A second requirement was to also show additional taxonomies not supported by the theme natively. While Hugo supports tags and categories by default, the theme only displays tags.\nSo how to adjust the position of tags starting from the theme’s default where tags are only shown above the title?\nHide tags above title: Overwrite content-header.html with an empty file. Show tags between title and content: Overwrite heading-post.html and add {{- partial \"tags.html\" . }} to it. Show tags below content: Overwrite content-footer.html and add {{- partial \"tags.html\" . }} to it. New The new parameter breadcrumbSeparator is now available in your config.toml to change the - well - separator of the breadcrumb items. An appropriate default is in place if you do not configure anything.\n5.13.0 (2023-05-17) Change The swagger shortcode was deprecated in favor for the openapi shortcode. You don’t need to change anything yet as the old name will be used as a fallback. It is planned to remove the swagger shortcode in the next major release.\nAdditionally, the implemantion of this shortcode was switched from RapiDoc to SwaggerUI.\n5.12.0 (2023-05-04) Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed (again). While Internet Explorer 11 has issues in displaying it, the functionality still works.\nNew Support for the great VSCode Front Matter extension which provides on-premise CMS capabilties to Hugo.\nThe theme provides Front Matter snippets for its shortcodes. Currently only English and German is supported. Put a reference into your frontmatter.json like this\n{ ... \"frontMatter.extends\": [ \"./vscode-frontmatter/snippets.en.json\" ] ... } New Support for languages that are written right to left (like Arabic) is now complete and extended to the menu, the top navigation bar and print. You can experience this in the pirate translation. This feature is not available in Internet Explorer 11.\nNew The scrollbars are now colored according to their variant color scheme to better fit into the visuals.\n5.11.0 (2023-02-07) Change The theme removed the popular jQuery library from its distribution.\nIn case you made changes to the theme that are dependend on this library you can place a copy of jQuery into your static/js directory and load it from your own layouts/partials/custom-header.html like this:\n\u003cscript src=\"{{\"js/jquery.min.js\"| relURL}}\" defer\u003e\u003c/script\u003e Change Mermaid diagrams can now be configured for pan and zoom on site-, page-level or individually for each graph.\nThe default setting of on, in effect since 1.1.0, changed back to off as there was interference with scrolling on mobile and big pages.\nChange The theme is now capable to visually adapt to your OS’s light/dark mode setting.\nThis is also the new default setting if you haven’t configured themeVariant in your config.toml.\nAdditionally you can configure the variants to be taken for light/dark mode with the new themeVariantAuto parameter.\nThis is not supported for Internet Explorer 11, which still displays in the relearn-light variant.\nChange The JavaScript code for handling image lightboxes (provided by Featherlight) was replaced by a CSS-only solution.\nThis also changed the lightbox effects parameter from featherlight=false to lightbox=false. Nevertheless you don’t need to change anything as the old name will be used as a fallback.\nChange In the effort to comply with WCAG standards, the implementation of the expand shortcode was changed. While Internet Explorer 11 has issues in displaying it, the functionality still works.\nNew Translation into Czech. This language is not supported for search.\nNew GitHub releases are also now tagged for the main version (eg. 1.2.x), major version (eg. 1.x) and the latest (just x) release making it easier for you to pin the theme to a certain version.\n5.10.0 (2023-01-25) New The attachments, badge, button and notice shortcodes have a new parameter color to set arbitrary CSS color values.\nAdditionally the --ACCENT-color brand color introduced in version 5.8.0 is now supported with these shortcodes.\n5.9.0 (2022-12-23) Breaking With this version it is now possible to not only have sections on the first menu level but also pages.\nIt was later discovered, that this causes pages only meant to be displayed in the More section of the menu and stored directly inside your content directory to now show up in the menu aswell.\nTo get rid of this undesired behavior you have two choices:\nMake the page file a headless branch bundle (contained in its own subdirectory and called _index.md) and add the following frontmatter configuration to the file (see exampleSite’s content/showcase/_index.en.md). This causes its content to not be ontained in the sitemap.\ntitle = \"Showcase\" [_build] render = \"always\" list = \"never\" publishResources = true Store the page file for below a parent headless branch bundle and add the following frontmatter to he parent (see exampleSite’s content/more/_index.en.md).\n# title = \"More\" ### ATTENTION: Don't give this page a title as this will cause it to be in the breadcrumbs - a thing you most likely don't want [_build] render = \"never\" list = \"never\" publishResources = falseIn this case, the file itself can be a branch bundle, leaf bundle or simple page (see exampleSite’s content/more/credits.en.md). This causes its content to be contained in the sitemap.\ntitle = \"Credits\" Change The required folder name for the attachments shortcode was changed for leaf bundles.\nPreviously, the attachments for leaf bundles in non-multilang setups were required to be in a files subdirectory. For page bundles and leaf bundles in multilang setups they were always required to be in a _index.\u003cLANGCODE\u003e.files or index.\u003cLANGCODE\u003e.files subdirectory accordingly.\nThis added unnessessary complexity. So attachments for leaf bundles in non-multilang setups can now also reside in a index.files directory. Although the old files directory is now deprecated, if both directories are present, only the old files directory will be used for compatiblity.\nChange Absolute links prefixed with http:// or https:// are now opened in a separate browser tab.\nYou can revert back to the old behavior by defining externalLinkTarget=\"_self\" in the params section of your config.toml.\nNew The theme now supports Hugo’s module system.\n5.8.0 (2022-12-08) New The new badge shortcode is now available to add highly configurable markers to your content as you can see it on this page.\nNew The new icon shortcode simplyfies the usage of icons. This can even be combined with also new badge shortcode.\nNew The theme now supports some of GFM (GitHub Flavored Markdown) syntax and Hugo Markdown extensions, namely task lists, defintion lists and footnotes.\nNew A new color --ACCENT-color was introduced which is used for highlightning search results on the page. In case you simply don’t care, you don’t need to change anything in your variant stylesheet as the old yellow color is still used as default.\n5.7.0 (2022-11-29) Change The Korean language translation for this theme is now available with the language code ko. Formerly the country code kr was used instead.\nNew The button shortcode can now also be used as a real button inside of HTML forms - although this is a pretty rare use case. The documentation was updated accordingly.\nNew The search now supports the Korean language.\n5.6.0 (2022-11-18) New This release introduces an additional dedicated search page. On this page, displayed search results have more space making it easier scanning thru large number of results.\nTo activate this feature, you need to configure it in your config.toml as a new outputformat SEARCHPAGE for the home page. If you don’t configure it, no dedicated search page will be accessible and the theme works as before.\nYou can access the search page by either clicking on the magnifier glass or pressing enter inside of the search box.\nNew Keyboard handling for the TOC and search was improved.\nPressing CTRL+ALT+t now will not only toggle the TOC overlay but also places the focus to the first heading on opening. Subsequently this makes it possible to easily select headings by using the TAB key.\nThe search received its own brand new keyboard shortcut CTRL+ALT+f. This will focus the cursor inside of the the search box so you can immediately start your search by typing.\nNew You are now able to turn off the generation of generator meta tags in your HTML head to hide the used versions of Hugo and this theme.\nTo configure this in your config.toml make sure to set Hugo’s disableHugoGeneratorInject=true and also [params] disableGeneratorVersion=true, otherwise Hugo will generate a meta tag into your home page automagically.\nNew Creation of your project gets a little bit faster with this release.\nThis addresses increased build time with the 5.x releases. The theme now heavily caches partial results leading to improved performance. To further increase performance, unnecessary parts of the page are now skipped for creation of the print output (eg. menus, navigation bar, etc.).\n5.5.0 (2022-11-06) Change The way images are processed has changed. Now images are lazy loaded by default which speeds up page load on slow networks and/or big pages and also the print preview.\nFor that the JavaScript code to handle the lightbox and image effects on the client side was removed in favour for static generation of those effects on the server.\nIf you have used HTML directly in your Markdown files, this now has the downside that it doesn’t respect the effect query parameter anymore. In this case you have to migrate all your HTML img URLs manually to the respective HTML attributes.\nOld New \u003cimg src=\"pic.png?width=20vw\u0026classes=shadow,border\"\u003e \u003cimg src=\"pic.png\" style=\"width:20vw;\" class=\"shadow border\"\u003e 5.4.0 (2022-11-01) Change With the proper settings in your config.toml your page is now servable from the local file system using file:// URLs.\nPlease note that the searchbox will only work for this if you reconfigure your outputformat for the homepage in your config.toml from JSON to SEARCH. The now deprecated JSON outputformat still works as before, so there is no need to reconfigure your installation if it is only served from http:// or https://.\nChange The button shortcode has a new parameter target to set the destination frame/window for the URL to open. If not given, it defaults to a new window/tab for external URLs or is not set at all for internal URLs. Previously even internal URLs where opened in a new window/tab.\nNew The math shortcode and mermaid shortcode now also support the align parameter if codefence syntax is used.\nNew Support for languages that are written right to left (like Arabic). This is only implemented for the content area but not the navigation sidebar. This feature is not available in Internet Explorer 11.\nNew Translation into Finnish (Suomi).\n5.3.0 (2022-10-07) Change In the effort to comply with WCAG standards, the implementation of the collapsible menu was changed. The functionality of the new implementation does not work with old browsers (Internet Explorer 11).\nNew Image formatting has two new classes to align images to the left or right. Additionally, the already existing inline option is now documented.\nNew Printing for the swagger shortcode was optimized to expand sections that are usually closed in interactive mode. This requires print support to be configured.\n5.2.0 (2022-08-03) Change If you’ve set collapsibleMenu = true in your config.toml, the menu will be expanded if a search term is found in a collapsed submenu. The menu will return to its initial collapse state once the search term does not match any submenus. 5.1.0 (2022-07-15) 0.95.0 This release requires a newer Hugo version.\nChange Because the print preview URLs were non deterministic for normal pages in comparison to page bundles, this is now changed. Each print preview is now accessible by adding a index.print.html to the default URL.\nYou can revert this behavior by overwriting the PRINT output format setting in your config.tomlto:\n[outputFormats] [outputFormats.PRINT] name= \"PRINT\" baseName = \"index\" path = \"_print\" isHTML = true mediaType = 'text/html' permalinkable = false 5.0.0 (2022-07-05) Breaking The theme changed how JavaScript and CSS dependencies are loaded to provide a better performance. In case you’ve added own JavaScript code that depends on the themes jQuery implementation, you have to put it into a separate *.js file (if not already) and add the defer keyword to the script element. Eg.\n\u003cscript defer src=\"myscript.js\"\u003e\u003c/script\u003e Change The way archetypes are used to generate output has changed. The new systems allows you, to redefine existing archetypes or even generate your own ones.\nYour existing markdown files will still work like before and therefore you don’t need to change anything after the upgrade. Nevertheless, it is recommended to adapt your existing markdown files to the new way as follows:\nfor your home page, add the frontmatter parameter archetype = \"home\" and remove the leading heading\nfor all files containing the deprecated frontmatter parameter chapter = true, replace it with archetype = \"chapter\" and remove the leading headings\nChange The frontmatter options pre / post were renamed to menuPre / menuPost. The old options will still be used if the new options aren’t set. Therefore you don’t need to change anything after the upgrade.\nNew Adding new partials heading-pre.html / heading-post.html and according frontmatter options headingPre / headingPost to modify the way your page`s main heading gets styled.\nNew The new shortcode math is available to add beautiful math and chemical formulae. See the documentation for available features. This feature will not work with Internet Explorer 11.\n4.2.0 (2022-06-23) Breaking The second parameter for the include shortcode was switched in meaning and was renamed from showfirstheading to hidefirstheading. If you haven’t used this parameter in your shortcode, the default behavior hasn’t changed and you don’t need to change anything.\nIf you’ve used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.\nChange Previously, if the tabs shortcode could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.\nChange The landingPageURL was removed from config.toml. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically and will point to the project’s homepage. If you want to support a different link, overwrite the logo.html partial.\nNew All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.\n4.1.0 (2022-06-12) New While fixing issues with the search functionality for non Latin languages, you can now configure to have multiple languages on a single page. 4.0.0 (2022-06-05) Breaking The custom_css config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the custom-header.html template in a much more generic manner.\nBreaking Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove --MAIN-ANCHOR-color instead. You don’t need to change anything in your custom color stylesheet as the anchors now get their colors from --MAIN-LINK-color and --MAIN-ANCHOR-HOVER-color respectively.\nNew All shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don’t need to change anything in your installation.\nThis applies to expand, include, notice and siteparam.\nNew The button shortcode received some love and now has a parameter for the color style similar to other shortcodes.\nNew New colors --PRIMARY-color and --SECONDARY-color were added to provide easier modification of your custom style. Shortcodes with a color style can now have primary or secondary as additional values.\nThese two colors are the default for other, more specific color variables. You don’t need to change anything in your existing custom color stylesheets as those variables get reasonable default values.\nNew Translation into Polish. This language is not supported for search.\nNew The documentation for all shortcodes were revised.\n3.4.0 (2022-04-03) Breaking If you had previously overwritten the custom-footer.html partial to add visual elements below the content of your page, you have to move this content to the new partial content-footer.html. custom-footer.html was never meant to contain HTML other than additional styles and JavaScript.\nNew If you prefer expandable/collapsible menu items, you can now set collapsibleMenu=true in your config.toml. This will add arrows to all menu items that contain sub menus. The menu will expand/collapse without navigation if you click on an arrow.\nNew You can activate print support in your config.toml to add the capability to print whole chapters or even the complete site.\nNew Translation into Traditional Chinese.\n3.3.0 (2022-03-28) New Introduction of new CSS variables to set the font. The theme distinguishes between --MAIN-font for all content text and --CODE-font for inline or block code. There are additional overrides for all headings. See the theme variant generator of the exampleSite for all available variables.\nNew The new shortcode swagger is available to include a UI for REST OpenAPI specifications. See the documentation for available features. This feature will not work with Internet Explorer 11.\n3.2.0 (2022-03-19) 0.93.0 This release requires a newer Hugo version.\nChange In this release the Mermaid JavaScript library will only be loaded on demand if the page contains a Mermaid shortcode or is using Mermaid codefences. This changes the behavior of disableMermaid config option as follows: If a Mermaid shortcode or codefence is found, the option will be ignored and Mermaid will be loaded regardlessly.\nThe option is still useful in case you are using scripting to set up your graph. In this case no shortcode or codefence is involved and the library is not loaded by default. In this case you can set disableMermaid=false in your frontmatter to force the library to be loaded. See the theme variant generator of the exampleSite for an example.\nNew Additional color variant variable --MERMAID-theme to set the variant’s Mermaid theme. This causes the Mermaid theme to switch with the color variant if it defers from the setting of the formerly selected color variant.\n3.1.0 (2022-03-15) New attachment and notice shortcodes have a new parameter to override the default icon. Allowed values are all Font Awesome 5 Free icons. 3.0.0 (2022-02-22) Breaking We made changes to the menu footer. If you have your menu-footer.html partial overridden, you may have to review the styling (eg. margins/paddings) in your partial. For a reference take a look into the menu-footer.html partial that is coming with the exampleSite.\nThis change was made to allow your own menu footer to be placed right after the so called prefooter that comes with the theme (containing the language switch and Clear history functionality).\nBreaking We have changed the default colors from the original Learn theme (the purple menu header) to the Relearn defaults (the light green menu header) as used in the official documentation.\nThis change will only affect your installation if you’ve not set the themeVariant parameter in your config.toml. If you still want to use the Learn color variant, you have to explicitly set themeVariant=\"learn\" in your config.toml.\nNote, that this will also affect your site if viewed with Internet Explorer 11 but in this case it can not be reconfigured as Internet Explorer does not support CSS variables.\nChange Due to a bug, that we couldn’t fix in a general manner for color variants, we decided to remove --MENU-SEARCH-BOX-ICONS-color and introduced --MENU-SEARCH-color instead. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange For consistency reasons, we renamed --MENU-SEARCH-BOX-color to --MENU-SEARCH-BORDER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nNew With this release you are now capable to define your own dark mode variants.\nTo make this possible, we have introduced a lot more color variables you can use in your color variants. Your old variants will still work and don’t need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.\nTo see what’s now possible, see the new variants relearn-dark and neon that are coming with this release.\nNew To make the creation of new variants easier for you, we’ve added a new interactive theme variant generator. This feature will not work with Internet Explorer 11.\nNew You can now configure multiple color variants in your config.toml. In this case, the first variant is the default chosen on first view and a variant selector will be shown in the menu footer. See the documentation for configuration.\nNote, that the new variant selector will not work with Internet Explorer 11 as it does not support CSS variables. Therefore, the variant selector will not be displayed with Internet Explorer 11.\n2.9.0 (2021-11-19) Breaking This release removes the themes implementation of ref/relref in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.\nIn a standard compliant form you must not link to the *.md file but to its logical name. You’ll see, referencing other pages becomes much easier. All three types result in the same reference:\nType Non-Standard Standard Branch bundle basics/configuration/_index.md basics/configuration Leaf bundle basics/configuration/index.md basics/configuration Page basics/configuration.md basics/configuration If you’ve linked from a page of one language to a page of another language, conversion is a bit more difficult but Hugo got you covered as well.\nAlso, 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.\nIn the best case your usage of the old implementation is already standard compliant 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.\nYou may see errors on the console after the update in the form:\nERROR 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 foundIn this case, you must apply one of two options:\nStart up a text editor with regular expression support for search and replace. Search for (ref\\s+\"[^\"]*?)(?:/_index|/index)?(?:\\.md)?(#[^\"]*?)?\" and replace it by $1$2\" in all *.md files. This is the recommended choice.\nCopy 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.\n2.8.0 (2021-11-03) Change Although never officially documented, this release removes the font Novacento/Novecento. If you use it in an overwritten CSS please replace it with Work Sans. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for Czech.\nNew The theme now supports favicons served from static/images/ named as favicon or logo in SVG, PNG or ICO format out of the box. An overridden partial layouts/partials/favicon.html may not be necessary anymore in most cases.\nNew You can hide the table of contents menu for the whole site by setting the disableToc option in your config.toml. For an example see the example configuration.\n2.7.0 (2021-10-24) New Optional second parameter for notice shortcode to set title in box header. 2.6.0 (2021-10-21) New Your site can now be served from a subfolder if you set baseURL and canonifyURLs=true in your config.toml. See the documentation for a detailed example. 2.5.0 (2021-10-08) Change New colors --CODE-BLOCK-color and --CODE-BLOCK-BG-color were added to provide a fallback for Hugos syntax highlighting in case no language was given or the language is unsupported. Ideally the colors are set to the same values as the ones from your chosen chroma style. 2.4.0 (2021-10-07) Change Creation of customized stylesheets was simplified down to only contain the CSS variables. Everything else can and should be deleted from your custom stylesheet to assure everything works fine. For the predefined stylesheet variants, this change is already included.\nNew Hidden pages are displayed by default in their according tags page. You can now turn off this behavior by setting disableTagHiddenPages=true in your config.toml.\nNew You can define the expansion state of your menus for the whole site by setting the alwaysopen option in your config.toml. Please see further documentation for possible values and default behavior.\nNew New frontmatter ordersectionsby option to change immediate children sorting in menu and children shortcode. Possible values are title or weight.\nNew Alternate content of a page is now advertised in the HTML meta tags. See Hugo documentation.\n2.3.0 (2021-09-13) 0.81.0 This release requires a newer Hugo version.\nNew Showcase multilanguage features by providing a documentation translation “fer us pirrrates”. There will be no other translations besides the original English one and the Pirates one due to maintenance constraints.\n2.2.0 (2021-09-09) New Hidden pages are displayed by default in the sitemap generated by Hugo and are therefore visible for search engine indexing. You can now turn off this behavior by setting disableSeoHiddenPages=true in your config.toml. 2.1.0 (2021-09-07) 0.69.0 This release requires a newer Hugo version.\nChange In case the site’s structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see CHANGELOG.md in the exampleSite), they will now be ignored by the search.\nNew Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting disableSearchHiddenPages=true in your config.toml.\nNew If a search term is found in an expand shortcode, the expand will be opened.\nNew The menu will scroll the active item into view on load.\n2.0.0 (2021-08-28) Change Syntax highlighting was switched to the built in Hugo mechanism. You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation\nChange In the predefined stylesheets there was a typo and --MENU-HOME-LINK-HOVERED-color must be changed to --MENU-HOME-LINK-HOVER-color. You don’t need to change anything in your custom color stylesheet as the old name will be used as a fallback.\nChange --MENU-HOME-LINK-color and --MENU-HOME-LINK-HOVER-color were missing in the documentation. You should add them to your custom stylesheets if you want to override the defaults.\nChange Arrow navigation and children shortcode were ignoring setting for ordersectionsby. This is now changed and may result in different sorting order of your sub pages.\nChange If hidden pages are accessed directly by typing their URL, they will be exposed in the menu.\nChange A page without a title will be treated as hidden=true.\nNew You can define the expansion state of your menus in the frontmatter. Please see further documentation for possible values and default behavior.\nNew New partials for defining pre/post content for menu items and the content. See documentation for further reading.\nNew Shortcode children with new parameter containerstyle.\nNew New shortcode include to include arbitrary file content into a page.\n1.2.0 (2021-07-26) New Shortcode expand with new parameter to open on page load. 1.1.0 (2021-07-02) Breaking Mermaid diagrams can now be panned and zoomed. This isn’t configurable yet.\nNew Mermaid config options can be set in config.toml.\n1.0.0 (2021-07-01) 0.65.0 The requirement for the Hugo version of this theme is the same as for the Learn theme version 2.5.0 on 2021-07-01.\nNew Initial fork of the Learn theme based on Learn 2.5.0 on 2021-07-01. This introduces no new features besides a global rename to Relearn and a new logo. For the reasons behind forking the Learn theme, see this comment in the Learn issues.\n", @@ -51,13 +51,11 @@ var relearn_search_index = [ }, { "breadcrumb": "Content", - "content": "Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.\nMarkdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it.\nSome of the key benefits are:\nMarkdown is simple to learn, with minimal extra characters so it’s also quicker to write content. Less chance of errors when writing in Markdown. Produces valid HTML output. Keeps the content and the visual display separate, so you cannot mess up the look of your site. Write in any text editor or Markdown application you like. Markdown is a joy to use! John Gruber, the author of Markdown, puts it like this:\nThe overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email. John Gruber\nWithout further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:\nTip Bookmark this page and the official Commonmark reference for easy future reference!\nParagraphs In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.\nAny text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.\nLorem 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. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt 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.\nHeadings A good idea is to structure your content using headings and subheadings. HTML-headings from h1 through h6 are constructed with a # for each level.\nIn Hugo you usually don’t use h1 as this is generated by your theme and you should only have one such element in a document.\n# h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading Result h1 Heading h2 Heading h3 Heading h4 Heading h5 Heading h6 Heading Horizontal Rules To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes ---.\nLorem 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. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt 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.\nText Markers Bold You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks **.\nI am rendered with **bold text** Result I am rendered with bold text\nItalics You can emphasize a snippet of text with italics by enclosing it with underscores _.\nI am rendered with _italicized text_ Result I am rendered with italicized text\nStrikethrough In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitution This Markdown dialect supports an extension to combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.\nDouble quotes `\"` and single quotes `'` of enclosed text are replaced by **\"double curly quotes\"** and **'single curly quotes'**. Double dashes `--` and triple dashes `---` are replaced by en-dash **--** and em-dash **---** entities. Double arrows pointing left `\u003c\u003c` or right `\u003e\u003e` are replaced by arrow **\u003c\u003c** and **\u003e\u003e** entities. Three consecutive dots `...` are replaced by an ellipsis **...** entity. Result Double quotes \" and single quotes ' of enclosed text are replaced by “double curly quotes” and ‘single curly quotes’.\nDouble dashes -- and triple dashes --- are replaced by en-dash – and em-dash — entities.\nDouble arrows pointing left \u003c\u003c or right \u003e\u003e are replaced by arrow « and » entities.\nThree consecutive dots ... are replaced by an ellipsis … entity.\nLists Unordered You can write a list of items in which the order of the items does not explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nYou may use any of -, * or + to denote bullets for each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipiscing elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipiscing elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered You can create a list of items in which the order of items does explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nMarkdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipiscing elit 1. Integer molestie lorem at massa 7. Facilisis in pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks In GFM (GitHub Flavored Markdown) you can add task lists resulting in checked or unchecked non-clickable items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definitions This Markdown dialect supports an extension to add definition lists. Definition lists are made of terms and definitions of these terms, much like in a dictionary.\nA definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.\nIf you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible\nApple : Pomaceous fruit of plants of the genus Malus in the family Rosaceae. : An American computer company. Orange : The fruit of an evergreen tree of the genus Citrus. You can make juice out of it. : A telecommunication company. You can't make juice out of it. Result Apple Pomaceous fruit of plants of the genus Malus in the family Rosaceae. An American computer company. Orange The fruit of an evergreen tree of the genus Citrus. You can make juice out of it.\nA telecommunication company. You can’t make juice out of it.\nCode Inline Code Inline snippets of code can be wrapped with backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` is marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e is marked as code.\nIndented Code Block A simple code block can be generated by indenting several lines of code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 of code line 2 of code line 3 of code Result Be impressed by my advanced code:\n// Some comments line 1 of code line 2 of code line 3 of code Fenced Code Block If you want to gain more control of your code block you can enclose your code by at least three backticks ``` a so called fence.\nIn GFM (GitHub Flavored Markdown) you can also add a language specifier directly after the opening fence, ```js, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.\nSee Code Highlighting for additional documentation.\n```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'] } } } }; ``` Result 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 In GFM (GitHub Flavored Markdown) you can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.\n| 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. | Result 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. Aligned Columns Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.\n| Option | Number | Description | |-------:|:------:|:------------| | data | 1 | path to data files to supply the data that will be passed into templates. | | engine | 2 | engine to be used for processing templates. Handlebars is the default. | | ext | 3 | extension to be used for dest files. | Result Option Number Description data 1 path to data files to supply the data that will be passed into templates. engine 2 engine to be used for processing templates. Handlebars is the default. ext 3 extension to be used for dest files. Blockquotes For quoting blocks of content from another source within your document add \u003e before any text you want to quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e 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. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\nSed 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.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.\nThis is a link to https://example.com. Result This is a link to https://example.com.\nBasic Link You can explicitly define links in case you want to use non-absolute URLs or want to give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink with Tooltip For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go to example domain\" Result Example\nFootnotes Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.\nUsually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.\nFootnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.\nThat's some text with a footnote[^1] [^1]: And that's the footnote. That's some more text with a footnote.[^someid] [^someid]: Anything of interest goes here. Blue light glows blue. Result That’s some text with a footnote1\nThat’s some more text with a footnote.2\nAnd that’s the footnote. ↩︎\nAnything of interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar syntax to links but include a preceding exclamation mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image with Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default behavior is configurable thru your config.toml or frontmatter parameter.\nResizing Add query parameter width and/or height to the link image to resize the image. Values are CSS values (default is auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combination ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add the query parameter lightbox=false to the image link to disable the lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Note If you want to wrap an image in a link and lightbox=true is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)\n", + "content": "Using the command: hugo new [relative new content path], you can start a content file with the date and title automatically set. While this is a welcome feature, active writers need more: archetypes. These are preconfigured skeleton pages with default frontmatter.\nThe Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.\nPredefined Archetypes Home A Home page is the starting page of your project. It’s best to have only one page of this kind in your project.\nTo create a home page, run the following command\nhugo new --kind home _index.mdThis leads to a file with the following content\n+++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum.Chapter 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 below it.\nTo create a chapter page, run the following command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads to a file with the following content\n+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace the X with a number. Because this number will be used to generate the subtitle of the chapter page, set the number to a consecutive value starting at 1 for each new chapter level.\nDefault A Default page is any other content page. If you set an unknown archetype in your frontmatter, this archetype will be used to generate the page.\nTo create a default page, run either one of the following commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads to a file with the following content\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace the X with a number or delete the whole weight parameter entirely.\nSelf defined Archetypes If you are in need of further archetypes you can define your own or even redefine existing ones.\nTemplate Define a template file in your project at archetypes/\u003ckind\u003e.md and make sure it has at least the frontmatter parameter for that archetype like\n+++ archetype = \"\u003ckind\u003e\" +++Afterwards you can generate new content files of that kind with the following command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials To define how your archetypes are rendered, define corresponding partial files in your projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf you use an unknown archetype in your frontmatter, the default archetype will be used to generate the page.\nRelated to each archetype, several hook partial files in the form of \u003chook\u003e.html can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.\nThe following hooks are used:\nName Notes styleclass Defines a set of CSS classes to be added to the HTML’s \u003cmain\u003e element. You can use these classes to define own CSS rules in your custom-header.html article Defines the HTML how to render your content Take a look at the existing archetypes of this theme to get an idea how to utilize it.\nOutput formats Each hook file can be overridden of a specific output format. Eg. if you define a new output format PLAINTEXT in your config.toml, you can add a file layouts/partials/archetypes/default.plaintext.html to change the way how normal content is written for that output format.\n", "description": "", - "tags": [ - "Content" - ], - "title": "Markdown syntax", - "uri": "/cont/markdown/index.html" + "tags": null, + "title": "Archetypes", + "uri": "/cont/archetypes/index.html" }, { "breadcrumb": "", @@ -75,6 +73,16 @@ var relearn_search_index = [ "title": "Development", "uri": "/dev/index.html" }, + { + "breadcrumb": "Content", + "content": "Let’s face it: Writing content for the web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.\nMarkdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it.\nSome of the key benefits are:\nMarkdown is simple to learn, with minimal extra characters so it’s also quicker to write content. Less chance of errors when writing in Markdown. Produces valid HTML output. Keeps the content and the visual display separate, so you cannot mess up the look of your site. Write in any text editor or Markdown application you like. Markdown is a joy to use! John Gruber, the author of Markdown, puts it like this:\nThe overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email. John Gruber\nWithout further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:\nTip Bookmark this page and the official Commonmark reference for easy future reference!\nParagraphs In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.\nAny text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.\nLorem 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. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt 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.\nHeadings A good idea is to structure your content using headings and subheadings. HTML-headings from h1 through h6 are constructed with a # for each level.\nIn Hugo you usually don’t use h1 as this is generated by your theme and you should only have one such element in a document.\n# h1 Heading ## h2 Heading ### h3 Heading #### h4 Heading ##### h5 Heading ###### h6 Heading Result h1 Heading h2 Heading h3 Heading h4 Heading h5 Heading h6 Heading Horizontal Rules To further structure your content you can add horizontal rules. They create a “thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes ---.\nLorem 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. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt 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.\nText Markers Bold You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks **.\nI am rendered with **bold text** Result I am rendered with bold text\nItalics You can emphasize a snippet of text with italics by enclosing it with underscores _.\nI am rendered with _italicized text_ Result I am rendered with italicized text\nStrikethrough In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitution This Markdown dialect supports an extension to combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.\nDouble quotes `\"` and single quotes `'` of enclosed text are replaced by **\"double curly quotes\"** and **'single curly quotes'**. Double dashes `--` and triple dashes `---` are replaced by en-dash **--** and em-dash **---** entities. Double arrows pointing left `\u003c\u003c` or right `\u003e\u003e` are replaced by arrow **\u003c\u003c** and **\u003e\u003e** entities. Three consecutive dots `...` are replaced by an ellipsis **...** entity. Result Double quotes \" and single quotes ' of enclosed text are replaced by “double curly quotes” and ‘single curly quotes’.\nDouble dashes -- and triple dashes --- are replaced by en-dash – and em-dash — entities.\nDouble arrows pointing left \u003c\u003c or right \u003e\u003e are replaced by arrow « and » entities.\nThree consecutive dots ... are replaced by an ellipsis … entity.\nLists Unordered You can write a list of items in which the order of the items does not explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nYou may use any of -, * or + to denote bullets for each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipiscing elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipiscing elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered You can create a list of items in which the order of items does explicitly matter.\nIt is possible to nest lists by indenting an item for the next sublevel.\nMarkdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipiscing elit 1. Integer molestie lorem at massa 7. Facilisis in pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipiscing elit Integer molestie lorem at massa Facilisis in pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks In GFM (GitHub Flavored Markdown) you can add task lists resulting in checked or unchecked non-clickable items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definitions This Markdown dialect supports an extension to add definition lists. Definition lists are made of terms and definitions of these terms, much like in a dictionary.\nA definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.\nIf you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible\nApple : Pomaceous fruit of plants of the genus Malus in the family Rosaceae. : An American computer company. Orange : The fruit of an evergreen tree of the genus Citrus. You can make juice out of it. : A telecommunication company. You can't make juice out of it. Result Apple Pomaceous fruit of plants of the genus Malus in the family Rosaceae. An American computer company. Orange The fruit of an evergreen tree of the genus Citrus. You can make juice out of it.\nA telecommunication company. You can’t make juice out of it.\nCode Inline Code Inline snippets of code can be wrapped with backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` is marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e is marked as code.\nIndented Code Block A simple code block can be generated by indenting several lines of code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 of code line 2 of code line 3 of code Result Be impressed by my advanced code:\n// Some comments line 1 of code line 2 of code line 3 of code Fenced Code Block If you want to gain more control of your code block you can enclose your code by at least three backticks ``` a so called fence.\nIn GFM (GitHub Flavored Markdown) you can also add a language specifier directly after the opening fence, ```js, and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.\nSee Code Highlighting for additional documentation.\n```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'] } } } }; ``` Result 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 In GFM (GitHub Flavored Markdown) you can create tables by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.\n| 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. | Result 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. Aligned Columns Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.\n| Option | Number | Description | |-------:|:------:|:------------| | data | 1 | path to data files to supply the data that will be passed into templates. | | engine | 2 | engine to be used for processing templates. Handlebars is the default. | | ext | 3 | extension to be used for dest files. | Result Option Number Description data 1 path to data files to supply the data that will be passed into templates. engine 2 engine to be used for processing templates. Handlebars is the default. ext 3 extension to be used for dest files. Blockquotes For quoting blocks of content from another source within your document add \u003e before any text you want to quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e 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. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\nSed 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.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.\nThis is a link to https://example.com. Result This is a link to https://example.com.\nBasic Link You can explicitly define links in case you want to use non-absolute URLs or want to give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink with Tooltip For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go to example domain\" Result Example\nFootnotes Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.\nUsually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.\nFootnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.\nThat's some text with a footnote[^1] [^1]: And that's the footnote. That's some more text with a footnote.[^someid] [^someid]: Anything of interest goes here. Blue light glows blue. Result That’s some text with a footnote1\nThat’s some more text with a footnote.2\nAnd that’s the footnote. ↩︎\nAnything of interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar syntax to links but include a preceding exclamation mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image with Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects This theme allows additional non-standard formatting by setting query parameter at the end of the image URL. The default behavior is configurable thru your config.toml or frontmatter parameter.\nResizing Add query parameter width and/or height to the link image to resize the image. Values are CSS values (default is auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combination ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add the query parameter lightbox=false to the image link to disable the lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Note If you want to wrap an image in a link and lightbox=true is your default setting, you have to explicitly disable the lightbox to avoid it to hijacking your link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)\n", + "description": "", + "tags": [ + "Content" + ], + "title": "Markdown syntax", + "uri": "/cont/markdown/index.html" + }, { "breadcrumb": "Content", "content": "The theme supports non-standard image effects.\nAs described, you can add this to the URL query parameter, but this may be cumbersome to do it consistently for the whole page.\nInstead, you can configure the defaults in your config.toml aswell as overriding these default in the pages frontmatter.\nExplicitly set URL query parameter will override the defaults in effect for a page.\nWithout any settings in your config.toml this defaults to\n​ config.toml [params] [params.imageEffects] border = false lightbox = true shadow = false This can be overridden in a pages frontmatter by eg.\n​ frontmatter +++ [imageEffects] border = true +++ Or by explicitly override settings by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true) The settings applied to the above image would be\n​ Result border = true lightbox = false shadow = false bg-white = true This ends up in the following HTML where the parameter are converted to CSS classes.\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true\" alt=\"Minion\" class=\"bg-white border nolightbox noshadow\"\u003e Extending As you can see in the above example, the bg-white parameter is not initially supported in the themes default settings. Nevertheless you are free to define arbitrary parameter by just adding them to the URL query parameter or set them in your config.toml or pages frontmatter.\nNote If no extended parameter like bg-white in the example is set on the URL, a class=\"nobg-white\" in the HTML will only be generated if a default value was set in the config.toml or pages frontmatter.\n", @@ -138,7 +146,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": "On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your config.toml. The defaults are written in the comments of each option.\nNote that some of these options are explained in detail in other sections of this documentation.\n​ config.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes aswell. # The author of your site. # Default: not set # This will be used in HTML meta tags, the opengraph protocol and twitter # cards. # You can also set `author.email` if you want to publish this information. author.name = \"Sören Weber\" # The social media image of your site. # Default: not set # This is used for generating social media meta information for the opengraph # protocol and twitter cards. # This can be overridden in the page's frontmatter. images = [ \"images/hero.png\" ] # The description of your site. # Default: not set # This is used for generating HTML meta tags, social media meta information # for the opengraph protocol and twitter cards. # This can be overridden in the page's frontmatter. description = \"Documentation for Hugo Relearn Theme\" # Admin options for social media. # Default: not set # Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo's # implementation. See the Hugo docs for possible values. social.facebook_admin = \"\" social.twitter = \"\" ############################################################################### # Relearn Theme # These options are specific to the Relearn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Variants # These options set your color variant. # Used color variants. # Default: \"auto\" # This sets one or more color variants, available to your readers to choose # from. You can # - set a single value eg. \"zen-light\" # - an array like [ \"neon\", \"learn\" ] # - an array with options like [ { identifier = \"neon\" },{ identifier = \"learn\" } ] # The last form allows to set further options for each variant. # The `identifier` is mandatory. You can also set `name` which overrides the # value displayed in the variant selector. # If the array has more than one entry, a variant selector # is shown in the lower part of the menu. The first entry in the array is the # default variant, used for first time visitors. # The theme ships with the following variants: \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". In addition you can use auto mode variants. See the # docs for a detailed explaination. # You can also define your own variants. See the docs how this works. Also, # the docs provide an interactive theme generator to help you with this task. themeVariant = [ { identifier = \"relearn-auto\", name = \"Relearn Light/Dark\", auto = [] }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"relearn-bright\" }, { identifier = \"zen-auto\", name = \"Zen Light/Dark\", auto = [ \"zen-light\", \"zen-dark\" ] }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These options are defining general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files and CSS-files get a unique ID on each rebuild. # This makes sure, the user always has the latest version and not some stale # copy of his browser cache. Anyways, it can be desireable to turn this # off in certain circumstances. For example if you have Hugo's dev server # running. Also some proxies dislike this optimization. disableAssetsBusting = false # Avoid generator meta tags. # Default: false # Set this to true if you want to disable generation for generator meta tags # of Hugo and the theme in your HTML head. In tihs case also don't forget to # set Hugo's disableHugoGeneratorInject=true. Otherwise Hugo will generate a # meta tag into your home page anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situations the theme generates non stable unique ids to be used # in HTML fragment links. This can be undesirable for example when testing # the output for changes. If you disable the random id generation, the theme # may not function correctly anymore. disableRandomIds = false # Multilanguage content. # Default: not set # If your pages contain further languages besides the main one used, add all # those auxiliary languages here. This will create a search index with # support for all used languages of your site. # This is handy for example if you are writing in Spanish but have lots of # source code on your page which typically uses English terminology. additionalContentLanguage = [ \"en\" ] # Additional code dependencies. # Default: See config.toml of the theme # The theme provides a mechanism to load further JavaScript and CSS # dependencies on demand only if they are needed. This comes in handy if you # want to add own shortcodes that depend on additional code to be loaded. # See the docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These options modify the topbar appearance. # Hide the table of contents button. # Default: false # If the TOC button is hidden, also the keyboard shortcut is disabled. # This can be overridden in the page's frontmatter. disableToc = false # Hide the breadcrumbs. # Default: false # If the breadcrumbs are hidden, the title of the displayed page will still be # shown in the topbar. disableBreadcrumb = false # Hide Next and Previous navigation buttons. # Default: false # If the navigation buttons are hidden, also the keyboard shortcuts are # disabled. disableNextPrev = false # The URL prefix to edit a page. # Default: not set # If set, an edit button will be shown in the topbar. If the button is hidden, # also the keyboard shortcuts are disabled. The given URL is prepended to the # relative file path of a the displayed page. The URL must end with a `/`. # This is useful if you wnat to give the opportunity for people to create merge # request for your content. editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu apperance. # Hide the search box. # Default: false # If the searc box is sisabled, the search functionality is disabled too. # This will also cause the keyboard shortcut to be disabled and the dedicated # search page is not linked although it mighty be configured. disableSearch = false # Hide the Home entry. # Default: false # If shown, a Home button will appear below the search bar and the main menu. # It links to your the home page of the current language. disableLandingPageButton = true # The order of main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adhering to # Hugo's default sort order). This can be overridden in the pages frontmatter. ordersectionsby = \"weight\" # The initial expand state of submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # in the menu. If not set, the first menu level is set to false, all others # levels are set to true. This can be overridden in the page's frontmatter. # If the displayed page has submenus, they will always been displayed expanded # regardless of this option. alwaysopen = \"\" # Shows expander for submenus. # Default: false # If set to true, a submenu in the sidebar will be displayed in a collapsible # tree view and a clickable expander is set in front of the entry. collapsibleMenu = true # Shows checkmarks for visited pages of the main menu. # Default: false # This also causes the display of the `Clear History` entry in the lower part # of the menu to remove all checkmarks. The checkmarks will also been removed # if you regenerate your site as the ids are not stable. showVisitedLinks = true # Hide heading above the shortcut menu. # Default: false # The title for the heading can be overwritten in your i18n files. See Hugo's # documentation how to do this. disableShortcutsTitle = false # Hide the language switcher. # Default: false # If you have more than one language configured, a language switcher is # displayed in the lower part of the menu. This opition lets you explicitly # turn this behavior off. disableLanguageSwitchingButton = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden pages # These options configure how hidden pages are treated. # A page flagged as hidden, is only removed from the main menu but behaves # like any other page for all other functionality in Hugo. # Hide hidden pages from search. # Default: false # Hides hidden pages from the suggestions of the search box and the dedicated # search page. disableSearchHiddenPages = false # Hide hidden pages for web crawlers. # Default: false # Avoids hidden pages from showing up in the sitemap and on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden pages for taxonomies. # Default: false # Hides hidden pages from showing up on the taxonomy and terms pages. If this # reduces term counters to zero, an empty but not linked term page will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Content # These options modify how your content is displayed. # Title separator. # Default: \"::\" # Changes the title separator used when concatenating the page title with the # site title. This is consistently used throughout the theme. titleSeparator = \"::\" # Breadcrumb separator. # Default: \"\u003e\" # Changes the breadcrumb separator used in the topbars breadcrumb area and for # search results and term pages. breadcrumbSeparator = \"\u003e\" # Hide the root breadcrumb. # Default: false # The root breadcrumb is usually the home page of your site. Because this is # always accessible by clicking on the logo, you may want to reduce clutter # by removing this from your breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term pages. # Default: false # If you have lots of taxonomy terms, the term pages may seem cluttered with # breadcrumbs to you, so this is the option to turn off breadcrumbs on term # pages. Only the page title will then be shown on the term pages. disableTermBreadcrumbs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These options configure how code is displayed. # Hide copy-to-clipboard for inline code. # Default: false # This removes the copy-to-clipboard button from your inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard for block code. # Default: false # The theme only shows the copy-to-clipboard button if you hover over the code # block. Set this to true to disable the hover effect and always show the # button. disableHoverBlockCopyToClipBoard = false # Wrap for code blocks. # Default: true # By default lines of code blocks wrap around if the line is too long to be # displayed on screen. If you dislike this behavior, you can reconfigure it # here. # Note that lines always wrap in print mode regardless of this option. # This can be overridden in the page's frontmatter or given as a parameter to # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These options configure how images are displayed. # Image effects. # See the documentation for how you can even add your own arbitrary effects to # the list. # All effects can be overridden in the page's frontmatter or thru URL parameter # given to the image. See the documentation for details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These options configure how links are displayed. # How to open external links. # Default: \"_blank\" # For external links you can define how they are opened in your browser. All # values for the HTML `target` attribute of the `a` element are allowed. The # default value opens external links in a separate browser tab. If you want # to open those links in the same tab, use \"_self\". externalLinkTarget = \"_blank\" # Generate link URLs the Hugo way. # Default: false # If set to true, the theme behaves like a standard Hugo installation and # appends no index.html to prettyURLs. As a trade off, your build project will # not be servable from the file system. disableExplicitIndexURLs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These options configure how math formulae are displayed. # Initialization options for MathJax. # Default: not set # A JSON value. See the MathJaxdocumentation for possible parameter. # This can be overridden in the page's frontmatter. mathJaxInitialize = \"{}\" # Only load MathJax if needed. # Default: true # If a Math shortcode is found, the option will be ignored and # MathJax will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMathJax=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. disableMathJax = true # URL for external MathJax library. # Default: not set # Specifies the remote location of the MathJax library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Mermaid # These options configure how Mermaid graphs are displayed. # Make graphs panable and zoomable # Default: false # For huge graphs it can be helpful to make them zoomable. Zoomable graphs come # with a reset button for the zoom. # This can be overridden in the page's frontmatter or given as a parameter to # individual graphs. mermaidZoom = true # Initialization options for Mermaid. # Default: not set # A JSON value. See the Mermaid documentation for possible parameter. # This can be overridden in the page's frontmatter. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only load Mermaid if needed. # Default: true # If a Mermaid shortcode or codefence is found, the option will be ignored and # Mermaid will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMermaid=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. disableMermaid = true # URL for external Mermaid library. # Default: not set # Specifies the remote location of the Mermaid library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These options configure how OpenAPI specifications are displayed. # Only load OpenAPI if needed. # Default: true # If a OpenAPI shortcode is found, the option will be ignored and # OpenAPI will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableOpenapi=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. disableOpenapi = true # URL for external OpenAPI library. # Default: not set # Specifies the remote location of the OpenAPI library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" ", + "content": "On top of Hugo’s global configuration options, the Relearn theme lets you define further options unique to the theme in your config.toml. The defaults are written in the comments of each option.\nNote that some of these options are explained in detail in other sections of this documentation.\n​ config.toml [params] # If an option value is said to be not set, you can achieve the same behavior # by given it an empty string value. ############################################################################### # Hugo # These options usually apply to other themes aswell. # The author of your site. # Default: not set # This will be used in HTML meta tags, the opengraph protocol and twitter # cards. # You can also set `author.email` if you want to publish this information. author.name = \"Sören Weber\" # The social media image of your site. # Default: not set # This is used for generating social media meta information for the opengraph # protocol and twitter cards. # This can be overridden in the page's frontmatter. images = [ \"images/hero.png\" ] # The description of your site. # Default: not set # This is used for generating HTML meta tags, social media meta information # for the opengraph protocol and twitter cards. # This can be overridden in the page's frontmatter. description = \"Documentation for Hugo Relearn Theme\" # Admin options for social media. # Default: not set # Configuration for the Open Graph protocol and Twitter Cards adhere to Hugo's # implementation. See the Hugo docs for possible values. social.facebook_admin = \"\" social.twitter = \"\" ############################################################################### # Relearn Theme # These options are specific to the Relearn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Variants # These options set your color variant. # Used color variants. # Default: \"auto\" # This sets one or more color variants, available to your readers to choose # from. You can # - set a single value eg. \"zen-light\" # - an array like [ \"neon\", \"learn\" ] # - an array with options like [ { identifier = \"neon\" },{ identifier = \"learn\" } ] # The last form allows to set further options for each variant. # The `identifier` is mandatory. You can also set `name` which overrides the # value displayed in the variant selector. # If the array has more than one entry, a variant selector # is shown in the lower part of the menu. The first entry in the array is the # default variant, used for first time visitors. # The theme ships with the following variants: \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". In addition you can use auto mode variants. See the # docs for a detailed explaination. # You can also define your own variants. See the docs how this works. Also, # the docs provide an interactive theme generator to help you with this task. themeVariant = [ { identifier = \"relearn-auto\", name = \"Relearn Light/Dark\", auto = [] }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"relearn-bright\" }, { identifier = \"zen-auto\", name = \"Zen Light/Dark\", auto = [ \"zen-light\", \"zen-dark\" ] }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These options are defining general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files and CSS-files get a unique ID on each rebuild. # This makes sure, the user always has the latest version and not some stale # copy of his browser cache. Anyways, it can be desireable to turn this # off in certain circumstances. For example if you have Hugo's dev server # running. Also some proxies dislike this optimization. disableAssetsBusting = false # Avoid generator meta tags. # Default: false # Set this to true if you want to disable generation for generator meta tags # of Hugo and the theme in your HTML head. In tihs case also don't forget to # set Hugo's disableHugoGeneratorInject=true. Otherwise Hugo will generate a # meta tag into your home page anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situations the theme generates non stable unique ids to be used # in HTML fragment links. This can be undesirable for example when testing # the output for changes. If you disable the random id generation, the theme # may not function correctly anymore. disableRandomIds = false # Multilanguage content. # Default: not set # If your pages contain further languages besides the main one used, add all # those auxiliary languages here. This will create a search index with # support for all used languages of your site. # This is handy for example if you are writing in Spanish but have lots of # source code on your page which typically uses English terminology. additionalContentLanguage = [ \"en\" ] # Additional code dependencies. # Default: See config.toml of the theme # The theme provides a mechanism to load further JavaScript and CSS # dependencies on demand only if they are needed. This comes in handy if you # want to add own shortcodes that depend on additional code to be loaded. # See the docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These options modify the topbar appearance. # Hide the table of contents button. # Default: false # If the TOC button is hidden, also the keyboard shortcut is disabled. # This can be overridden in the page's frontmatter. disableToc = false # Hide the breadcrumbs. # Default: false # If the breadcrumbs are hidden, the title of the displayed page will still be # shown in the topbar. disableBreadcrumb = false # Hide Next and Previous navigation buttons. # Default: false # If the navigation buttons are hidden, also the keyboard shortcuts are # disabled. disableNextPrev = false # The URL prefix to edit a page. # Default: not set # If set, an edit button will be shown in the topbar. If the button is hidden, # also the keyboard shortcuts are disabled. The given URL is prepended to the # relative file path of a the displayed page. The URL must end with a `/`. # This is useful if you wnat to give the opportunity for people to create merge # request for your content. editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These options modify the menu apperance. # Hide the search box. # Default: false # If the searc box is sisabled, the search functionality is disabled too. # This will also cause the keyboard shortcut to be disabled and the dedicated # search page is not linked although it mighty be configured. disableSearch = false # Hide the Home entry. # Default: false # If shown, a Home button will appear below the search bar and the main menu. # It links to your the home page of the current language. disableLandingPageButton = true # The order of main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adhering to # Hugo's default sort order). This can be overridden in the pages frontmatter. ordersectionsby = \"weight\" # The initial expand state of submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # in the menu. If not set, the first menu level is set to false, all others # levels are set to true. This can be overridden in the page's frontmatter. # If the displayed page has submenus, they will always been displayed expanded # regardless of this option. alwaysopen = \"\" # Shows expander for submenus. # Default: false # If set to true, a submenu in the sidebar will be displayed in a collapsible # tree view and a clickable expander is set in front of the entry. collapsibleMenu = true # Shows checkmarks for visited pages of the main menu. # Default: false # This also causes the display of the `Clear History` entry in the lower part # of the menu to remove all checkmarks. The checkmarks will also been removed # if you regenerate your site as the ids are not stable. showVisitedLinks = true # Hide heading above the shortcut menu. # Default: false # The title for the heading can be overwritten in your i18n files. See Hugo's # documentation how to do this. disableShortcutsTitle = false # Hide the language switcher. # Default: false # If you have more than one language configured, a language switcher is # displayed in the lower part of the menu. This opition lets you explicitly # turn this behavior off. disableLanguageSwitchingButton = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden pages # These options configure how hidden pages are treated. # A page flagged as hidden, is only removed from the main menu if you are # currently not on this page or the hidden page is not part of current page's # ancestors. For all other functionality in Hugo a hidden page behaves like any # other page if not otherwise configured. # Hide hidden pages from search. # Default: false # Hides hidden pages from the suggestions of the search box and the dedicated # search page. disableSearchHiddenPages = false # Hide hidden pages for web crawlers. # Default: false # Avoids hidden pages from showing up in the sitemap and on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden pages for taxonomies. # Default: false # Hides hidden pages from showing up on the taxonomy and terms pages. If this # reduces term counters to zero, an empty but not linked term page will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Content # These options modify how your content is displayed. # Title separator. # Default: \"::\" # Changes the title separator used when concatenating the page title with the # site title. This is consistently used throughout the theme. titleSeparator = \"::\" # Breadcrumb separator. # Default: \"\u003e\" # Changes the breadcrumb separator used in the topbars breadcrumb area and for # search results and term pages. breadcrumbSeparator = \"\u003e\" # Hide the root breadcrumb. # Default: false # The root breadcrumb is usually the home page of your site. Because this is # always accessible by clicking on the logo, you may want to reduce clutter # by removing this from your breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term pages. # Default: false # If you have lots of taxonomy terms, the term pages may seem cluttered with # breadcrumbs to you, so this is the option to turn off breadcrumbs on term # pages. Only the page title will then be shown on the term pages. disableTermBreadcrumbs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These options configure how code is displayed. # Hide copy-to-clipboard for inline code. # Default: false # This removes the copy-to-clipboard button from your inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard for block code. # Default: false # The theme only shows the copy-to-clipboard button if you hover over the code # block. Set this to true to disable the hover effect and always show the # button. disableHoverBlockCopyToClipBoard = false # Wrap for code blocks. # Default: true # By default lines of code blocks wrap around if the line is too long to be # displayed on screen. If you dislike this behavior, you can reconfigure it # here. # Note that lines always wrap in print mode regardless of this option. # This can be overridden in the page's frontmatter or given as a parameter to # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These options configure how images are displayed. # Image effects. # See the documentation for how you can even add your own arbitrary effects to # the list. # All effects can be overridden in the page's frontmatter or thru URL parameter # given to the image. See the documentation for details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These options configure how links are displayed. # How to open external links. # Default: \"_blank\" # For external links you can define how they are opened in your browser. All # values for the HTML `target` attribute of the `a` element are allowed. The # default value opens external links in a separate browser tab. If you want # to open those links in the same tab, use \"_self\". externalLinkTarget = \"_blank\" # Generate link URLs the Hugo way. # Default: false # If set to true, the theme behaves like a standard Hugo installation and # appends no index.html to prettyURLs. As a trade off, your build project will # not be servable from the file system. disableExplicitIndexURLs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These options configure how math formulae are displayed. # Initialization options for MathJax. # Default: not set # A JSON value. See the MathJaxdocumentation for possible parameter. # This can be overridden in the page's frontmatter. mathJaxInitialize = \"{}\" # Only load MathJax if needed. # Default: true # If a Math shortcode is found, the option will be ignored and # MathJax will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMathJax=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. disableMathJax = true # URL for external MathJax library. # Default: not set # Specifies the remote location of the MathJax library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Mermaid # These options configure how Mermaid graphs are displayed. # Make graphs panable and zoomable # Default: false # For huge graphs it can be helpful to make them zoomable. Zoomable graphs come # with a reset button for the zoom. # This can be overridden in the page's frontmatter or given as a parameter to # individual graphs. mermaidZoom = true # Initialization options for Mermaid. # Default: not set # A JSON value. See the Mermaid documentation for possible parameter. # This can be overridden in the page's frontmatter. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only load Mermaid if needed. # Default: true # If a Mermaid shortcode or codefence is found, the option will be ignored and # Mermaid will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableMermaid=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. disableMermaid = true # URL for external Mermaid library. # Default: not set # Specifies the remote location of the Mermaid library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These options configure how OpenAPI specifications are displayed. # Only load OpenAPI if needed. # Default: true # If a OpenAPI shortcode is found, the option will be ignored and # OpenAPI will be loaded regardlessly. The option is still useful in case you # are using scripting to set up your graph. In this case no shortcode or # codefence is involved and the library is not loaded by default. In this case # you can set `disableOpenapi=false` in your frontmatter to force the library to # be loaded. # This can be overridden in the page's frontmatter. disableOpenapi = true # URL for external OpenAPI library. # Default: not set # Specifies the remote location of the OpenAPI library. By default the shipped # version will be used. # This can be overridden in the page's frontmatter. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" ", "description": "", "tags": [ "config" diff --git a/more/credits/index.html b/more/credits/index.html index 467d94bc97..4bbdaebc7b 100644 --- a/more/credits/index.html +++ b/more/credits/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/more/credits/index.print.html b/more/credits/index.print.html index e5fe06c078..821f97d786 100644 --- a/more/credits/index.print.html +++ b/more/credits/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/404.html b/pir/404.html index 30cbd20344..7adef8f722 100644 --- a/pir/404.html +++ b/pir/404.html @@ -19,21 +19,21 @@ 404 Page not found :: Cap'n Hugo Relearrrn Theme - + - - - - - - - - - - - - - + + + + + + + + + + + + + - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/branding/index.print.html b/pir/basics/branding/index.print.html index ea0eb78905..421b956373 100644 --- a/pir/basics/branding/index.print.html +++ b/pir/basics/branding/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/configuration/index.html b/pir/basics/configuration/index.html index 2ae740f371..67246cedf3 100644 --- a/pir/basics/configuration/index.html +++ b/pir/basics/configuration/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/configuration/index.print.html b/pir/basics/configuration/index.print.html index 7b4beae565..da5d59f219 100644 --- a/pir/basics/configuration/index.print.html +++ b/pir/basics/configuration/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/customization/index.html b/pir/basics/customization/index.html index 66da1b68a0..1358579da6 100644 --- a/pir/basics/customization/index.html +++ b/pir/basics/customization/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/customization/index.print.html b/pir/basics/customization/index.print.html index 20edabd9a5..f42b57d2b4 100644 --- a/pir/basics/customization/index.print.html +++ b/pir/basics/customization/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/generator/index.html b/pir/basics/generator/index.html index 6af06f380e..5ef9257c6b 100644 --- a/pir/basics/generator/index.html +++ b/pir/basics/generator/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/generator/index.print.html b/pir/basics/generator/index.print.html index 7fadccddec..3a62af5a92 100644 --- a/pir/basics/generator/index.print.html +++ b/pir/basics/generator/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/history/index.html b/pir/basics/history/index.html index 1b26749e11..1ac204afd7 100644 --- a/pir/basics/history/index.html +++ b/pir/basics/history/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/history/index.print.html b/pir/basics/history/index.print.html index 6ac600be4f..4280395429 100644 --- a/pir/basics/history/index.print.html +++ b/pir/basics/history/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/index.html b/pir/basics/index.html index bc24e3e3ec..548ce1a244 100644 --- a/pir/basics/index.html +++ b/pir/basics/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/index.print.html b/pir/basics/index.print.html index 1e5b4d86f7..d1f48b39c8 100644 --- a/pir/basics/index.print.html +++ b/pir/basics/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - + + + + + + + + + + + + + - + diff --git a/pir/basics/installation/index.html b/pir/basics/installation/index.html index aabeffbfa0..07ff2cc5d6 100644 --- a/pir/basics/installation/index.html +++ b/pir/basics/installation/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/installation/index.print.html b/pir/basics/installation/index.print.html index 3b91d5293e..d12516e2cc 100644 --- a/pir/basics/installation/index.print.html +++ b/pir/basics/installation/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/migration/index.html b/pir/basics/migration/index.html index 80d80fdd0c..35675768d5 100644 --- a/pir/basics/migration/index.html +++ b/pir/basics/migration/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/migration/index.print.html b/pir/basics/migration/index.print.html index 94c29c4f02..c65922845e 100644 --- a/pir/basics/migration/index.print.html +++ b/pir/basics/migration/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/requirements/index.html b/pir/basics/requirements/index.html index 9650e6cf99..2ca391aeb8 100644 --- a/pir/basics/requirements/index.html +++ b/pir/basics/requirements/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/requirements/index.print.html b/pir/basics/requirements/index.print.html index 20b19e711e..9aec7799da 100644 --- a/pir/basics/requirements/index.print.html +++ b/pir/basics/requirements/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/basics/topbar/index.html b/pir/basics/topbar/index.html index 09666be526..4133b5591f 100644 --- a/pir/basics/topbar/index.html +++ b/pir/basics/topbar/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/basics/topbar/index.print.html b/pir/basics/topbar/index.print.html index f21ee30153..e1764f5767 100644 --- a/pir/basics/topbar/index.print.html +++ b/pir/basics/topbar/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/categories/basic/index.html b/pir/categories/basic/index.html index 532d9cde7a..9b82ed124c 100644 --- a/pir/categories/basic/index.html +++ b/pir/categories/basic/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/content/index.html b/pir/categories/content/index.html index 09169a7af7..6406cdf43c 100644 --- a/pir/categories/content/index.html +++ b/pir/categories/content/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/custom/index.html b/pir/categories/custom/index.html index a746bc0981..453ea47b56 100644 --- a/pir/categories/custom/index.html +++ b/pir/categories/custom/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/index.html b/pir/categories/index.html index 1fca854faa..75d6512f34 100644 --- a/pir/categories/index.html +++ b/pir/categories/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/taxonomy/index.html b/pir/categories/taxonomy/index.html index 03dfeacc0e..c6b096f366 100644 --- a/pir/categories/taxonomy/index.html +++ b/pir/categories/taxonomy/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/categories/theming/index.html b/pir/categories/theming/index.html index 4c8b4a35bf..fde049f082 100644 --- a/pir/categories/theming/index.html +++ b/pir/categories/theming/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/archetypes/index.html b/pir/cont/archetypes/index.html index 476a58dc98..983b723041 100644 --- a/pir/cont/archetypes/index.html +++ b/pir/cont/archetypes/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/archetypes/index.print.html b/pir/cont/archetypes/index.print.html index fde8736b81..e3aea47ab2 100644 --- a/pir/cont/archetypes/index.print.html +++ b/pir/cont/archetypes/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/pages/frontmatter-icon.png b/pir/cont/frontmatter/frontmatter-icon.png similarity index 100% rename from pir/cont/pages/frontmatter-icon.png rename to pir/cont/frontmatter/frontmatter-icon.png diff --git a/pir/cont/frontmatter/index.html b/pir/cont/frontmatter/index.html new file mode 100644 index 0000000000..4a5cde3833 --- /dev/null +++ b/pir/cont/frontmatter/index.html @@ -0,0 +1,710 @@ + + + + + + + + + + + + + + + + + + + + Frrrontmatter :: Cap'n Hugo Relearrrn Theme + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+

Frrrontmatter

+ + +

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

+
+++
+# If an opt'n value be said t' be not set, ye can achieve th' same behavior
+# by given it an empty str'n value.
+
+###############################################################################
+# Cap'n Hugo
+# These opt'ns usually apply t' other themes aswell.
+
+# Th' social media image o' yer plank.
+# Default: not set
+# This be used fer generat'n social media meta informat'n fer th' opengraph
+# protocol an' twitter cards.
+# If not set, th' set value o' yer site's config.toml be used.
+images = [ "images/hero.png" ]
+
+# Th' title o' yer plank.
+# Default: not set
+# A plank without a title be treated as a hidden plank.
+title = "Example Page"
+
+# Th' descript'n o' yer plank.
+# Default: not set
+# This be used fer generat'n HTML meta tags, social media meta informat'n
+# fer th' opengraph protocol an' twitter cards.
+# If not set, th' set value o' yer site's config.toml be used fer th' html
+# meta tag, social media meta informat'n fer th' opengraph protocol an'
+# twitter cards.
+descript'n = ""
+
+###############################################################################
+# Relearrrn Theme
+# These opt'ns be specific t' th' Relearrrn theme.
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Topbar
+# These opt'ns modify th' topbar appearance.
+
+# Hide th' t'ble o' contents button.
+# Default: false
+# If th' TOC button be hidden, also th' keyboard shortcut be disabled.
+# If not set, th' set value o' yer site's config.toml be used.
+disableToc = false
+
+# Hide th' breadcrumbs.
+# Default: false
+# If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be
+# shown 'n th' topbar.
+disableBreadcrumb = false
+
+# Hide Next an' Previous navigat'n buttons.
+# Default: false
+# If th' navigat'n buttons be hidden, also th' keyboard shortcuts be
+# disabled.
+disableNextPrev = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Menu
+# These opt'ns modify th' menu apperance.
+
+# Th' title 'n main menu.
+# Default: <title>
+# If set, this will be used fer th' page's menu entry instead o' th' `title`
+# opt'n.
+menuTitle = ""
+
+# Prefix fer th' title 'n main menu.
+# Default: not set
+# Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n.
+menuPre = ""
+
+# Suffix fer th' title 'n main menu.
+# Default: not set
+# Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n.
+menuPost = ""
+
+# Th' order o' main menu submenus.
+# Default: "weight"
+# Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",
+# "expirydate", "publishdate", "date", "length" or "default" (adher'n t'
+# Hugo's default sort order).
+# If not set, th' value o' th' parent menu entry be used.
+ordersectionsby = "weight"
+
+# Th' initial expand state o' submenus.
+# Default: not set
+# This controls whether submenus will be expanded (true), or collapsed (false)
+# 'n th' menu. If not set, th' first menu level be set t' false, all others
+# levels be set t' true. If not set, th' value o' th' parent menu entry be used.
+# If th' displayed plank has submenus, they will always been displayed expanded
+# regardless o' this opt'n.
+alwaysopen = ""
+
+# Shows expander fer submenus.
+# Default: false
+# If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble
+# tree view an' a click'ble expander be set 'n front o' th' entry.
+collapsibleMenu = true
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Hidden planks
+# These opt'ns configure how hidden planks be treated.
+# A plank flagged as hidden, be only removed from th' main menu if ye be
+# currently not on this plank or th' hidden plank be not part o' current page's
+# ancestors. For all other functionality 'n Hugo a hidden plank behaves like any
+# other plank if not otherwise configured.
+
+# Hide a page's menu entry.
+# Default: false
+# If this value be true, th' plank be hidden from th' menu.
+hidden = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Rrrambl'n
+# These opt'ns modify how yer rrrambl'n be displayed.
+
+# Prefix fer th' title 'n th' rrrambl'n area.
+# Default: not set
+# Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n.
+headingPre = ""
+
+# Suffix fer th' title 'n th' rrrambl'n area.
+# Default: not set
+# Th' title o' th' plank head'n will be suffixed by this HTML rrrambl'n.
+headingPost = ""
+
+# Display name o' th' page's last editor.
+# Default: not set
+# If set, it will be displayed 'n th' default footer.
+LastModifierDisplayName = ""
+
+# Email address o' th' page's last editor.
+# Default: not set
+# If set together wit' LastModifierDisplayName, it will be displayed 'n th'
+# default footer.
+LastModifierEmail = ""
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Highlight
+# These opt'ns configure how code be displayed.
+
+# Wrap fer code blocks.
+# Default: true
+# By default lines o' code blocks wrap around if th' line be too long t' be
+# displayed on screen. If ye dislike this behavior, ye can reconfigure it
+# here.
+# Avast that lines always wrap 'n print mode regardless o' this opt'n.
+# If not set, th' set value o' yer site's config.toml be used or given as a
+# parameter t' individual code blocks.
+highlightWrap = true
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Images
+# These opt'ns configure how images be displayed.
+
+# Image effects.
+# See th' documentat'n fer how ye can even add yer own arbitrary effects t'
+# th' list.
+# All effect values default t' th' values o' yer site's config.toml an' can be
+# overridden thru URL parameter given t' th' image. See th' documentat'n fer
+# details.
+
+# Default: false
+imageEffects.border = true
+# Default: true
+imageEffects.lightbox = true
+# Default: false
+imageEffects.shadow = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# MathJax
+# These opt'ns configure how math formulae be displayed.
+
+# Initializat'n opt'ns fer MathJax.
+# Default: not set
+# A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter.
+# If not set, th' set value o' yer site's config.toml be used.
+mathJaxInitialize = "{}"
+
+# Only board MathJax if needed.
+# Default: true
+# If a Math shortcode be found, th' opt'n will be ignored an'
+# MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye
+# be us'n script'n t' set up yer graph. In this case no shortcode or
+# codefence be involved an' th' library be not boarded by default. In this case
+# ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t'
+# be boarded.
+# If not set, th' set value o' yer site's config.toml be used.
+disableMathJax = true
+
+# URL fer external MathJax library.
+# Default: not set
+# Specifies th' remote locat'n o' th' MathJax library. By default th' shipped
+# version will be used.
+# If not set, th' set value o' yer site's config.toml be used.
+customMathJaxURL = "" # "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Merrrmaid
+# These opt'ns configure how Merrrmaid graphs be displayed.
+
+# Make graphs pan'ble an' zoom'ble
+# Default: false
+# For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come
+# wit' a reset button fer th' zoom.
+# If not set, th' set value o' yer site's config.toml be used or given as a
+# parameter t' individual graphs.
+mermaidZoom = true
+
+# Initializat'n opt'ns fer Merrrmaid.
+# Default: not set
+# A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter.
+# If not set, th' set value o' yer site's config.toml be used.
+mermaidInitialize = "{ \"securityLevel\": \"loose\" }"
+
+# Only board Merrrmaid if needed.
+# Default: true
+# If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an'
+# Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye
+# be us'n script'n t' set up yer graph. In this case no shortcode or
+# codefence be involved an' th' library be not boarded by default. In this case
+# ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t'
+# be boarded.
+# If not set, th' set value o' yer site's config.toml be used.
+disableMermaid = true
+
+# URL fer external Merrrmaid library.
+# Default: not set
+# Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped
+# version will be used.
+# If not set, th' set value o' yer site's config.toml be used.
+customMermaidURL = "" # "https://unpkg.com/mermaid/dist/mermaid.min.js"
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# OpenApi
+# These opt'ns configure how OpenAPI specificat'ns be displayed.
+
+# Only board OpenAPI if needed.
+# Default: true
+# If a OpenAPI shortcode be found, th' opt'n will be ignored an'
+# OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye
+# be us'n script'n t' set up yer graph. In this case no shortcode or
+# codefence be involved an' th' library be not boarded by default. In this case
+# ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t'
+# be boarded.
+# If not set, th' set value o' yer site's config.toml be used.
+disableOpenapi = true
+
+# URL fer external OpenAPI library.
+# Default: not set
+# Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped
+# version will be used.
+# If not set, th' set value o' yer site's config.toml be used.
+customOpenapiURL = "" # "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
++++

Some Detailed Examples

+

Add Ay'con t' a Menu Entry

+

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

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

Title wit' icon +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

+

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

+

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:

+
    +
  • all parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns
    • +
  • immediate children entries o' th' active plank be shown regardless o' any sett'ns
    • +
  • if not overridden, all other first level entries behave like they would have been given alwaysopen=false
    • +
  • if not overridden, all other entries o' levels besides th' first behave like they would have been given alwaysopen=true
    • +
  • all vis'ble entries show their immediate children entries if alwaysopen=true; this proceeds recursively
    • +
  • all remain'n entries be not shown
    • +
+

Ye can see this feature 'n act'n on th' example plank fer children shortcode an' its children planks.

+

Dis'ble Sect'n Planks

+

Ye may want t' structure yer planks 'n a hierachical way but don’t want t' generate planks fer those sections? Th' theme got ye covered.

+

T' stay wit' th' initial example: Suppose ye want level-one appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.

+

For this, open content/level-one/_index.md an' add th' follow'n frontmatter

+
+++
+collapsibleMenu = true # this adds th' expander t' th' menu entry if not already set 'n yer config.toml
+[_build]
+  render = "never" # no plank will be generated so th' plank does not have a url
++++
+ +
+
+
+
+
+
+ + + + + + diff --git a/pir/cont/frontmatter/index.print.html b/pir/cont/frontmatter/index.print.html new file mode 100644 index 0000000000..5176eab6a2 --- /dev/null +++ b/pir/cont/frontmatter/index.print.html @@ -0,0 +1,407 @@ + + + + + + + + + + + + + + + + + + + + Frrrontmatter :: Cap'n Hugo Relearrrn Theme + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+
+
+
+

Frrrontmatter

+ + +

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

+
+++
+# If an opt'n value be said t' be not set, ye can achieve th' same behavior
+# by given it an empty str'n value.
+
+###############################################################################
+# Cap'n Hugo
+# These opt'ns usually apply t' other themes aswell.
+
+# Th' social media image o' yer plank.
+# Default: not set
+# This be used fer generat'n social media meta informat'n fer th' opengraph
+# protocol an' twitter cards.
+# If not set, th' set value o' yer site's config.toml be used.
+images = [ "images/hero.png" ]
+
+# Th' title o' yer plank.
+# Default: not set
+# A plank without a title be treated as a hidden plank.
+title = "Example Page"
+
+# Th' descript'n o' yer plank.
+# Default: not set
+# This be used fer generat'n HTML meta tags, social media meta informat'n
+# fer th' opengraph protocol an' twitter cards.
+# If not set, th' set value o' yer site's config.toml be used fer th' html
+# meta tag, social media meta informat'n fer th' opengraph protocol an'
+# twitter cards.
+descript'n = ""
+
+###############################################################################
+# Relearrrn Theme
+# These opt'ns be specific t' th' Relearrrn theme.
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Topbar
+# These opt'ns modify th' topbar appearance.
+
+# Hide th' t'ble o' contents button.
+# Default: false
+# If th' TOC button be hidden, also th' keyboard shortcut be disabled.
+# If not set, th' set value o' yer site's config.toml be used.
+disableToc = false
+
+# Hide th' breadcrumbs.
+# Default: false
+# If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be
+# shown 'n th' topbar.
+disableBreadcrumb = false
+
+# Hide Next an' Previous navigat'n buttons.
+# Default: false
+# If th' navigat'n buttons be hidden, also th' keyboard shortcuts be
+# disabled.
+disableNextPrev = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Menu
+# These opt'ns modify th' menu apperance.
+
+# Th' title 'n main menu.
+# Default: <title>
+# If set, this will be used fer th' page's menu entry instead o' th' `title`
+# opt'n.
+menuTitle = ""
+
+# Prefix fer th' title 'n main menu.
+# Default: not set
+# Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n.
+menuPre = ""
+
+# Suffix fer th' title 'n main menu.
+# Default: not set
+# Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n.
+menuPost = ""
+
+# Th' order o' main menu submenus.
+# Default: "weight"
+# Submenus can be ordered by "weight", "title", "linktitle", "modifieddate",
+# "expirydate", "publishdate", "date", "length" or "default" (adher'n t'
+# Hugo's default sort order).
+# If not set, th' value o' th' parent menu entry be used.
+ordersectionsby = "weight"
+
+# Th' initial expand state o' submenus.
+# Default: not set
+# This controls whether submenus will be expanded (true), or collapsed (false)
+# 'n th' menu. If not set, th' first menu level be set t' false, all others
+# levels be set t' true. If not set, th' value o' th' parent menu entry be used.
+# If th' displayed plank has submenus, they will always been displayed expanded
+# regardless o' this opt'n.
+alwaysopen = ""
+
+# Shows expander fer submenus.
+# Default: false
+# If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble
+# tree view an' a click'ble expander be set 'n front o' th' entry.
+collapsibleMenu = true
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Hidden planks
+# These opt'ns configure how hidden planks be treated.
+# A plank flagged as hidden, be only removed from th' main menu if ye be
+# currently not on this plank or th' hidden plank be not part o' current page's
+# ancestors. For all other functionality 'n Hugo a hidden plank behaves like any
+# other plank if not otherwise configured.
+
+# Hide a page's menu entry.
+# Default: false
+# If this value be true, th' plank be hidden from th' menu.
+hidden = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Rrrambl'n
+# These opt'ns modify how yer rrrambl'n be displayed.
+
+# Prefix fer th' title 'n th' rrrambl'n area.
+# Default: not set
+# Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n.
+headingPre = ""
+
+# Suffix fer th' title 'n th' rrrambl'n area.
+# Default: not set
+# Th' title o' th' plank head'n will be suffixed by this HTML rrrambl'n.
+headingPost = ""
+
+# Display name o' th' page's last editor.
+# Default: not set
+# If set, it will be displayed 'n th' default footer.
+LastModifierDisplayName = ""
+
+# Email address o' th' page's last editor.
+# Default: not set
+# If set together wit' LastModifierDisplayName, it will be displayed 'n th'
+# default footer.
+LastModifierEmail = ""
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Highlight
+# These opt'ns configure how code be displayed.
+
+# Wrap fer code blocks.
+# Default: true
+# By default lines o' code blocks wrap around if th' line be too long t' be
+# displayed on screen. If ye dislike this behavior, ye can reconfigure it
+# here.
+# Avast that lines always wrap 'n print mode regardless o' this opt'n.
+# If not set, th' set value o' yer site's config.toml be used or given as a
+# parameter t' individual code blocks.
+highlightWrap = true
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Images
+# These opt'ns configure how images be displayed.
+
+# Image effects.
+# See th' documentat'n fer how ye can even add yer own arbitrary effects t'
+# th' list.
+# All effect values default t' th' values o' yer site's config.toml an' can be
+# overridden thru URL parameter given t' th' image. See th' documentat'n fer
+# details.
+
+# Default: false
+imageEffects.border = true
+# Default: true
+imageEffects.lightbox = true
+# Default: false
+imageEffects.shadow = false
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# MathJax
+# These opt'ns configure how math formulae be displayed.
+
+# Initializat'n opt'ns fer MathJax.
+# Default: not set
+# A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter.
+# If not set, th' set value o' yer site's config.toml be used.
+mathJaxInitialize = "{}"
+
+# Only board MathJax if needed.
+# Default: true
+# If a Math shortcode be found, th' opt'n will be ignored an'
+# MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye
+# be us'n script'n t' set up yer graph. In this case no shortcode or
+# codefence be involved an' th' library be not boarded by default. In this case
+# ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t'
+# be boarded.
+# If not set, th' set value o' yer site's config.toml be used.
+disableMathJax = true
+
+# URL fer external MathJax library.
+# Default: not set
+# Specifies th' remote locat'n o' th' MathJax library. By default th' shipped
+# version will be used.
+# If not set, th' set value o' yer site's config.toml be used.
+customMathJaxURL = "" # "https://unpkg.com/mathjax/es5/tex-mml-chtml.js"
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# Merrrmaid
+# These opt'ns configure how Merrrmaid graphs be displayed.
+
+# Make graphs pan'ble an' zoom'ble
+# Default: false
+# For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come
+# wit' a reset button fer th' zoom.
+# If not set, th' set value o' yer site's config.toml be used or given as a
+# parameter t' individual graphs.
+mermaidZoom = true
+
+# Initializat'n opt'ns fer Merrrmaid.
+# Default: not set
+# A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter.
+# If not set, th' set value o' yer site's config.toml be used.
+mermaidInitialize = "{ \"securityLevel\": \"loose\" }"
+
+# Only board Merrrmaid if needed.
+# Default: true
+# If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an'
+# Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye
+# be us'n script'n t' set up yer graph. In this case no shortcode or
+# codefence be involved an' th' library be not boarded by default. In this case
+# ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t'
+# be boarded.
+# If not set, th' set value o' yer site's config.toml be used.
+disableMermaid = true
+
+# URL fer external Merrrmaid library.
+# Default: not set
+# Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped
+# version will be used.
+# If not set, th' set value o' yer site's config.toml be used.
+customMermaidURL = "" # "https://unpkg.com/mermaid/dist/mermaid.min.js"
+
+#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# OpenApi
+# These opt'ns configure how OpenAPI specificat'ns be displayed.
+
+# Only board OpenAPI if needed.
+# Default: true
+# If a OpenAPI shortcode be found, th' opt'n will be ignored an'
+# OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye
+# be us'n script'n t' set up yer graph. In this case no shortcode or
+# codefence be involved an' th' library be not boarded by default. In this case
+# ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t'
+# be boarded.
+# If not set, th' set value o' yer site's config.toml be used.
+disableOpenapi = true
+
+# URL fer external OpenAPI library.
+# Default: not set
+# Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped
+# version will be used.
+# If not set, th' set value o' yer site's config.toml be used.
+customOpenapiURL = "" # "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
++++

Some Detailed Examples

+

Add Ay'con t' a Menu Entry

+

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

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

Title wit' icon +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

+

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

+

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:

+
    +
  • all parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns
    • +
  • immediate children entries o' th' active plank be shown regardless o' any sett'ns
    • +
  • if not overridden, all other first level entries behave like they would have been given alwaysopen=false
    • +
  • if not overridden, all other entries o' levels besides th' first behave like they would have been given alwaysopen=true
    • +
  • all vis'ble entries show their immediate children entries if alwaysopen=true; this proceeds recursively
    • +
  • all remain'n entries be not shown
    • +
+

Ye can see this feature 'n act'n on th' example plank fer children shortcode an' its children planks.

+

Dis'ble Sect'n Planks

+

Ye may want t' structure yer planks 'n a hierachical way but don’t want t' generate planks fer those sections? Th' theme got ye covered.

+

T' stay wit' th' initial example: Suppose ye want level-one appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.

+

For this, open content/level-one/_index.md an' add th' follow'n frontmatter

+
+++
+collapsibleMenu = true # this adds th' expander t' th' menu entry if not already set 'n yer config.toml
+[_build]
+  render = "never" # no plank will be generated so th' plank does not have a url
++++
+ +
+
+
+ +
+
+
+ + + + + diff --git a/pir/cont/frontmatter/index.xml b/pir/cont/frontmatter/index.xml new file mode 100644 index 0000000000..2ab8aca4e1 --- /dev/null +++ b/pir/cont/frontmatter/index.xml @@ -0,0 +1,11 @@ + + + + Frrrontmatter on Cap'n Hugo Relearrrn Theme + https://McShelby.github.io/hugo-theme-relearn/pir/cont/frontmatter/index.html + Recent content in Frrrontmatter on Cap'n Hugo Relearrrn Theme + Hugo -- gohugo.io + art-pir + + + \ No newline at end of file diff --git a/pir/cont/i18n/index.html b/pir/cont/i18n/index.html index a0c3d7f4d0..080b415d91 100644 --- a/pir/cont/i18n/index.html +++ b/pir/cont/i18n/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/i18n/index.print.html b/pir/cont/i18n/index.print.html index 9e703dfc5d..bb53fcdd61 100644 --- a/pir/cont/i18n/index.print.html +++ b/pir/cont/i18n/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/imageeffects/index.html b/pir/cont/imageeffects/index.html index b01599f2c3..db972bbf85 100644 --- a/pir/cont/imageeffects/index.html +++ b/pir/cont/imageeffects/index.html @@ -32,21 +32,21 @@ Without any sett'ns 'n yer config.toml this defaults t'"> - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/imageeffects/index.print.html b/pir/cont/imageeffects/index.print.html index d9915f1d67..188fd0ace1 100644 --- a/pir/cont/imageeffects/index.print.html +++ b/pir/cont/imageeffects/index.print.html @@ -32,22 +32,22 @@ Without any sett'ns 'n yer config.toml this defaults t'"> - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/index.html b/pir/cont/index.html index e78c615f40..f04e3595f8 100644 --- a/pir/cont/index.html +++ b/pir/cont/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/index.print.html b/pir/cont/index.print.html index 61614b4335..ec8e832b3e 100644 --- a/pir/cont/index.print.html +++ b/pir/cont/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/index.xml b/pir/cont/index.xml index 914cd6c355..238207cfe8 100644 --- a/pir/cont/index.xml +++ b/pir/cont/index.xml @@ -15,6 +15,14 @@ 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 &lt;-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a. + + + Frrrontmatter + https://McShelby.github.io/hugo-theme-relearn/pir/cont/frontmatter/index.html + Mon, 01 Jan 0001 00:00:00 +0000 + https://McShelby.github.io/hugo-theme-relearn/pir/cont/frontmatter/index.html + Each Cap'n Hugo plank has t' define a frontmatter 'n toml, yaml or json. This ship will use toml fer documentat'n 'n all cases. ++++ # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' social media image o' yer plank. Arrrchetypes diff --git a/pir/cont/markdown/index.html b/pir/cont/markdown/index.html index 150119e146..d4c9a37074 100644 --- a/pir/cont/markdown/index.html +++ b/pir/cont/markdown/index.html @@ -30,21 +30,21 @@ Marrrkdown be simple t' learn, wit' minimal extra characters so it&rsquo - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/markdown/index.print.html b/pir/cont/markdown/index.print.html index 77f08757e8..cc8c9e6f37 100644 --- a/pir/cont/markdown/index.print.html +++ b/pir/cont/markdown/index.print.html @@ -30,22 +30,22 @@ Marrrkdown be simple t' learn, wit' minimal extra characters so it&rsquo - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/menushortcuts/index.html b/pir/cont/menushortcuts/index.html index f3ffafdd7f..7897a45701 100644 --- a/pir/cont/menushortcuts/index.html +++ b/pir/cont/menushortcuts/index.html @@ -30,21 +30,21 @@ Example from th' current website: - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/menushortcuts/index.print.html b/pir/cont/menushortcuts/index.print.html index b15d91cd8b..0793f80e68 100644 --- a/pir/cont/menushortcuts/index.print.html +++ b/pir/cont/menushortcuts/index.print.html @@ -30,22 +30,22 @@ Example from th' current website: - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/pages/index.html b/pir/cont/pages/index.html index 2e82395acd..c605a9139c 100644 --- a/pir/cont/pages/index.html +++ b/pir/cont/pages/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/pages/index.print.html b/pir/cont/pages/index.print.html index 3f6043bbaa..9878e9f65b 100644 --- a/pir/cont/pages/index.print.html +++ b/pir/cont/pages/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/cont/taxonomy/index.html b/pir/cont/taxonomy/index.html index 116a81a3b9..85ba971719 100644 --- a/pir/cont/taxonomy/index.html +++ b/pir/cont/taxonomy/index.html @@ -30,21 +30,21 @@ Th' categories be displayed at th' bottom o' th' plank 'n al - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/cont/taxonomy/index.print.html b/pir/cont/taxonomy/index.print.html index fb99aa6579..baad6d8268 100644 --- a/pir/cont/taxonomy/index.print.html +++ b/pir/cont/taxonomy/index.print.html @@ -30,22 +30,22 @@ Th' categories be displayed at th' bottom o' th' plank 'n al - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/contributing/index.html b/pir/dev/contributing/index.html index 83c7b51d1d..8202ea492b 100644 --- a/pir/dev/contributing/index.html +++ b/pir/dev/contributing/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/contributing/index.print.html b/pir/dev/contributing/index.print.html index f0ed4b98e3..1befaebdf6 100644 --- a/pir/dev/contributing/index.print.html +++ b/pir/dev/contributing/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/index.html b/pir/dev/index.html index 0b1ed9ec17..ca52b53d82 100644 --- a/pir/dev/index.html +++ b/pir/dev/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/index.print.html b/pir/dev/index.print.html index f1f3b2d3c2..4c6ab411e5 100644 --- a/pir/dev/index.print.html +++ b/pir/dev/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/maintaining/index.html b/pir/dev/maintaining/index.html index fa708cd3a1..91549c5786 100644 --- a/pir/dev/maintaining/index.html +++ b/pir/dev/maintaining/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/maintaining/index.print.html b/pir/dev/maintaining/index.print.html index 8afba61400..4d5e10382c 100644 --- a/pir/dev/maintaining/index.print.html +++ b/pir/dev/maintaining/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/dev/screenshots/index.html b/pir/dev/screenshots/index.html index c85482f931..5068d94c7b 100644 --- a/pir/dev/screenshots/index.html +++ b/pir/dev/screenshots/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/dev/screenshots/index.print.html b/pir/dev/screenshots/index.print.html index c0443d2e5e..a9509f7aa1 100644 --- a/pir/dev/screenshots/index.print.html +++ b/pir/dev/screenshots/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/index.html b/pir/index.html index 6bb4b7f582..927d3776fe 100644 --- a/pir/index.html +++ b/pir/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/index.print.html b/pir/index.print.html index 6d3db5a9bc..aaada98548 100644 --- a/pir/index.print.html +++ b/pir/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - + + - - - - - - - - - - - - + + + + + + + + + + + + - - + + - + diff --git a/pir/index.search.js b/pir/index.search.js index 623299c002..ce24e9c740 100644 --- a/pir/index.search.js +++ b/pir/index.search.js @@ -19,7 +19,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " 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.\nFolders Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rrrambl'n folder wit' all yer planks.\nrrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Avast _index.md be required 'n each folder, it’s yer “folder home page”\nCreate yer project 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 great documentat'n fer beginners.\nCap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003eTh' Relearrrn theme provides archetypes t' help ye create this kind o' planks.\nFrontmatter Configurat'n Each Cap'n Hugo plank has t' define a frontmatter 'n toml, yaml or json. This ship will use toml 'n all cases.\nTh' Relearrrn theme uses th' follow'n parameters on top o' Cap'n Hugo ones:\n+++ # 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 t' true, th' menu 'n th' sidebar will be displayed 'n a collaps'ble tree view. Although th' functionality works wit' old browsers (IE11), th' display o' th' expander ay'cons be limited t' modern browsers collapsibleMenu = false # 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 = \"weight\" # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n headingPre = \"\" # Th' title o' th' plank head'n will be postfixed by this HTML rrrambl'n headingPost = \"\" # Th' title o' th' plank 'n menu will be prefixed by this HTML rrrambl'n menuPre = \"\" # Th' title o' th' plank 'n menu will be postfixed by this HTML rrrambl'n menuPost = \"\" # 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 = \"\" # Override default values fer image effects, ye can even add yer own arbitrary effects t' th' list [params.imageEffects] border = false lightbox = true shadow = false +++Add ay'con t' a menu entry In th' plank frontmatter, add a menuPre param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.\n+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Order'n sibl'n menu/page entries Cap'n Hugo provides a flex'ble way t' handle order fer yer planks.\nTh' simplest way be t' set weight parameter t' a number.\n+++ 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).\nBut 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:\nFor example (for a plank named content/install/linux.md):\n+++ 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.\nTh' theme generates th' menu based on th' follow'n rules:\nall parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns immediate children entries o' th' active plank be shown regardless o' any sett'ns if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries o' levels besides th' first behave like they would have been given alwaysopen=true all vis'ble entries show their immediate children entries if alwaysopen=true; this proceeds recursively all remain'n entries be not shown Ye can see this feature 'n act'n on th' example plank fer children shortcode an' its children planks.\nDis'ble Sect'n Planks Ye may want t' structure yer planks 'n a hierachical way but don’t want t' generate planks fer those sections? Th' theme got ye covered.\nT' stay wit' th' initial example: Suppose ye want level-one appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.\nFor this, open content/level-one/_index.md an' add th' follow'n frontmatter\ncollapsibleMenu = true # this adds th' expander t' th' menu entry if not already set 'n yer config.toml [_build] render = \"never\" # no plank will be generated so th' plank does not have a url ", + "content": " 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.\nFolders Org'nize yer ship like any other Cap'n Hugo project. Typically, ye will have a rrrambl'n folder wit' all yer planks.\nrrrambl'n ├── level-one │ ├── level-two │ │ ├── level-three │ │ │ ├── level-four │ │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three/level-four │ │ │ │ ├── page-4-a.md \u003c-- /level-one/level-two/level-three/level-four/page-4-a │ │ │ │ ├── page-4-b.md \u003c-- /level-one/level-two/level-three/level-four/page-4-b │ │ │ │ └── page-4-c.md \u003c-- /level-one/level-two/level-three/level-four/page-4-c │ │ │ ├── _index.md \u003c-- /level-one/level-two/level-three │ │ │ ├── page-3-a.md \u003c-- /level-one/level-two/level-three/page-3-a │ │ │ ├── page-3-b.md \u003c-- /level-one/level-two/level-three/page-3-b │ │ │ └── page-3-c.md \u003c-- /level-one/level-two/level-three/page-3-c │ │ ├── _index.md \u003c-- /level-one/level-two │ │ ├── page-2-a.md \u003c-- /level-one/level-two/page-2-a │ │ ├── page-2-b.md \u003c-- /level-one/level-two/page-2-b │ │ └── page-2-c.md \u003c-- /level-one/level-two/page-2-c │ ├── _index.md \u003c-- /level-one │ ├── page-1-a.md \u003c-- /level-one/page-1-a │ ├── page-1-b.md \u003c-- /level-one/page-1-b │ └── page-1-c.md \u003c-- /level-one/page-1-c ├── _index.md \u003c-- / └── page-top.md \u003c-- /page-top Avast _index.md be required 'n each folder, it’s yer “folder home page”\nCreate yer project 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 great documentat'n fer beginners.\nCap'n Hugo provides a new command t' create a new website.\nhugo new ship \u003cnew_project\u003eTh' Relearrrn theme provides archetypes t' help ye create this kind o' planks.\n", "description": "", "tags": null, "title": "planks orrrganizat'n", @@ -27,11 +27,11 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " Us'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes. These be preconfigured skeleton planks wit' default frontmatter.\nTh' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.\nPredefined Archetypes Home A Home plank be th' start'n plank o' yer project. It’s best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum.Chapter 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 below it.\nT' create a chapter plank, run th' follow'n command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number. Because this number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.\nDefault A Default plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.\nT' create a default plank, run either one o' th' follow'n commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number or delete th' whole weight parameter entirely.\nSelf defined Archetypes If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.\nTemplate Define a template file 'n yer project at archetypes/\u003ckind\u003e.md an' make sure it has at least th' frontmatter parameter fer that archetype like\n+++ archetype = \"\u003ckind\u003e\" +++Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf ye use an unknown archetype 'n yer frontmatter, th' default archetype will be used t' generate th' plank.\nRelated t' each archetype, several hook partial files 'n th' form o' \u003chook\u003e.html can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.\nTh' follow'n hooks be used:\nName Notes styleclass Defines a set o' CSS classes t' be added t' th' HTML’s \u003cmain\u003e element. Ye can use these classes t' define own CSS rules 'n yer custom-header.html article Defines th' HTML how t' render yer rrrambl'n Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.\nOutput formats Each hook file can be overridden o' a specific output format. Eg. if ye define a new output format PLAINTEXT 'n yer config.toml, ye can add a file layouts/partials/archetypes/default.plaintext.html t' change th' way how normal rrrambl'n be written fer that output format.\n", + "content": " Each Cap'n Hugo plank has t' define a frontmatter 'n toml, yaml or json. This ship will use toml fer documentat'n 'n all cases.\n+++ # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' social media image o' yer plank. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # If not set, th' set value o' yer site's config.toml be used. images = [ \"images/hero.png\" ] # Th' title o' yer plank. # Default: not set # A plank without a title be treated as a hidden plank. title = \"Example Page\" # Th' descript'n o' yer plank. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # If not set, th' set value o' yer site's config.toml be used fer th' html # meta tag, social media meta informat'n fer th' opengraph protocol an' # twitter cards. descript'n = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # If not set, th' set value o' yer site's config.toml be used. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu apperance. # Th' title 'n main menu. # Default: \u003ctitle\u003e # If set, this will be used fer th' page's menu entry instead o' th' `title` # opt'n. menuTitle = \"\" # Prefix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be prefixed by this HTML rrrambl'n. menuPre = \"\" # Suffix fer th' title 'n main menu. # Default: not set # Th' title o' th' plank 'n th' menu will be suffixed by this HTML rrrambl'n. menuPost = \"\" # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). # If not set, th' value o' th' parent menu entry be used. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. If not set, th' value o' th' parent menu entry be used. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\" # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. collapsibleMenu = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide a page's menu entry. # Default: false # If this value be true, th' plank be hidden from th' menu. hidden = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Prefix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be prefixed by this HTML rrrambl'n. headingPre = \"\" # Suffix fer th' title 'n th' rrrambl'n area. # Default: not set # Th' title o' th' plank head'n will be suffixed by this HTML rrrambl'n. headingPost = \"\" # Display name o' th' page's last editor. # Default: not set # If set, it will be displayed 'n th' default footer. LastModifierDisplayName = \"\" # Email address o' th' page's last editor. # Default: not set # If set together wit' LastModifierDisplayName, it will be displayed 'n th' # default footer. LastModifierEmail = \"\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # If not set, th' set value o' yer site's config.toml be used or given as a # parameter t' individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effect values default t' th' values o' yer site's config.toml an' can be # overridden thru URL parameter given t' th' image. See th' documentat'n fer # details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's config.toml be used. mathJaxInitialize = \"{}\" # Only board MathJax if needed. # Default: true # If a Math shortcode be found, th' opt'n will be ignored an' # MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's config.toml be used. disableMathJax = true # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's config.toml be used. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # If not set, th' set value o' yer site's config.toml be used or given as a # parameter t' individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # If not set, th' set value o' yer site's config.toml be used. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only board Merrrmaid if needed. # Default: true # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's config.toml be used. disableMermaid = true # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's config.toml be used. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Only board OpenAPI if needed. # Default: true # If a OpenAPI shortcode be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t' # be boarded. # If not set, th' set value o' yer site's config.toml be used. disableOpenapi = true # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # If not set, th' set value o' yer site's config.toml be used. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" +++Some Detailed Examples Add Ay'con t' a Menu Entry In th' plank frontmatter, add a menuPre param t' insert any HTML code before th' menu label. Th' example below uses th' GitHub ay'con.\n+++ title = \"GitHub repo\" menuPre = \"\u003ci class='fab fa-github'\u003e\u003c/i\u003e \" +++ Order'n Sibl'n Menu/Page Entries Cap'n Hugo provides a flex'ble way t' handle order fer yer planks.\nTh' simplest way be t' set weight parameter t' a number.\n+++ 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).\nBut 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:\nFor example (for a plank named content/install/linux.md):\n+++ 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.\nTh' theme generates th' menu based on th' follow'n rules:\nall parent entries o' th' active plank includ'n their sibl'ns be shown regardless o' any sett'ns immediate children entries o' th' active plank be shown regardless o' any sett'ns if not overridden, all other first level entries behave like they would have been given alwaysopen=false if not overridden, all other entries o' levels besides th' first behave like they would have been given alwaysopen=true all vis'ble entries show their immediate children entries if alwaysopen=true; this proceeds recursively all remain'n entries be not shown Ye can see this feature 'n act'n on th' example plank fer children shortcode an' its children planks.\nDis'ble Sect'n Planks Ye may want t' structure yer planks 'n a hierachical way but don’t want t' generate planks fer those sections? Th' theme got ye covered.\nT' stay wit' th' initial example: Suppose ye want level-one appear 'n th' sidebar but don’t want t' generate a plank fer it. So th' entry 'n th' sidebar should not be click'ble but should show an expander.\nFor this, open content/level-one/_index.md an' add th' follow'n frontmatter\n+++ collapsibleMenu = true # this adds th' expander t' th' menu entry if not already set 'n yer config.toml [_build] render = \"never\" # no plank will be generated so th' plank does not have a url +++ ", "description": "", "tags": null, - "title": "Arrrchetypes", - "uri": "/pir/cont/archetypes/index.html" + "title": "Frrrontmatter", + "uri": "/pir/cont/frontmatter/index.html" }, { "breadcrumb": "", @@ -51,13 +51,11 @@ var relearn_search_index = [ }, { "breadcrumb": "Rambl'n", - "content": " Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\nMarrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid HTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship. Write 'n any text editor or Marrrkdown applicat'n ye like. Marrrkdown be a joy t' use! John Gruber, th' author o' Marrrkdown, puts it like this:\nTh' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email. John Gruber\nWithout further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:\nSmarrrt Arrrse Bookmark this plank an' th' official Commonmark reference fer easy future reference!\nParagraphs In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.\nAny text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.\nLorem 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. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt 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.\nHead'ns A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from h1 through h6 be constructed wit' a # fer each level.\nIn Hugo ye usually don’t use h1 as this be generated by yer theme an' ye should only have one such element 'n a document.\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Result h1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n Horizontal Rules T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes ---.\nLorem 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. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt 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.\nText Markers Bold Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks **.\nI am rendered wit' **bold text** Result I am rendered wit' bold text\nItalics Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores _.\nI am rendered wit' _italicized text_ Result I am rendered wit' italicized text\nStrikethrough In GFM (GitHub Flavored Markdown) ye can do strikethroughs by enclos'n text wit' two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitut'n This Marrrkdown dialect supports an extension t' combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.\nDo'ble quotes `\"` an' single quotes `'` o' enclosed text be replaced by **\"do'ble curly quotes\"** an' **'single curly quotes'**. Do'ble dashes `--` an' triple dashes `---` be replaced by en-dash **--** an' em-dash **---** entities. Do'ble arrows point'n left `\u003c\u003c` or right `\u003e\u003e` be replaced by arrow **\u003c\u003c** an' **\u003e\u003e** entities. Three consecutive dots `...` be replaced by an ellipsis **...** entity. Result Do'ble quotes \" an' single quotes ' o' enclosed text be replaced by “do'ble curly quotes” an' ‘single curly quotes’.\nDo'ble dashes -- an' triple dashes --- be replaced by en-dash – an' em-dash — entities.\nDo'ble arrows point'n left \u003c\u003c or right \u003e\u003e be replaced by arrow « an' » entities.\nThree consecutive dots ... be replaced by an ellipsis … entity.\nLists Unordered Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nYe may use any o' -, * or + t' denote bullets fer each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipisc'n elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered Ye can create a list o' items 'n which th' order o' items does explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nMarrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipisc'n elit 1. Integer molestie lorem at massa 7. Facilisis 'n pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks In GFM (GitHub Flavored Markdown) ye can add task lists result'n 'n checked or unchecked non-click'ble items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definit'ns This Marrrkdown dialect supports an extension t' add definit'n lists. Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.\nA definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.\nIf ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble\nApple : Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. : An American computer company. Orange : Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it. : A telecommunicat'n company. Ye can't make juice out o' it. Result Apple Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. An American computer company. Orange Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it.\nA telecommunicat'n company. Ye can’t make juice out o' it.\nCode Inline Code Inline snippets o' code can be wrapped wit' backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` be marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e be marked as code.\nIndented Code Block A simple code block can be generated by indent'n several lines o' code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 o' code line 2 o' code line 3 o' code Result Be impressed by my advanced code:\n// Some comments line 1 o' code line 2 o' code line 3 o' code Fenced Code Block If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks ``` a so called fence.\nIn GFM (GitHub Flavored Markdown) ye can also add a language specifier directly after th' open'n fence, ```js, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.\nSee Code Highlight'n fer additional documentat'n.\n```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'] } } } }; ``` Result 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 In GFM (GitHub Flavored Markdown) ye can create tables 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.\n| 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. | Result 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. Aligned Columns Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.\n| Opt'n | Number | Descript'n | |-------:|:------:|:------------| | data | 1 | path t' data files t' supply th' data that will be passed into templates. | | engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | 3 | extension t' be used fer dest files. | Result Opt'n Number Descript'n data 1 path t' data files t' supply th' data that will be passed into templates. engine 2 engine t' be used fer process'n templates. Handlebars be th' default. ext 3 extension t' be used fer dest files. Blockquotes For quot'n blocks o' rrrambl'n from another source within yer document add \u003e before any text ye want t' quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e 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. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\nSed 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.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.\nThis be a link t' https://example.com. Result This be a link t' https://example.com.\nBasic Link Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink wit' Tooltip For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go t' example domain\" Result Example\nFootnotes Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.\nUsually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.\nFootnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.\nThat's some text wit' a footnote[^1] [^1]: An' that's th' footnote. That's some more text wit' a footnote.[^someid] [^someid]: Anyth'n o' interest goes here. Blue light glows blue. Result That’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar rules t' links but include a preced'n exclamat'n mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image wit' Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. Th' default behavior be configur'ble thru yer config.toml or frontmatter parameter.\nResiz'n Add query parameter width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combinat'n ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add th' query parameter lightbox=false t' th' image link t' dis'ble th' lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Avast If ye want t' wrap an image 'n a link an' lightbox=true be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)\n", + "content": " Us'n th' command: hugo new [relative new rrrambl'n path], ye can start a rrrambl'n file wit' th' date an' title automatically set. While this be a welcome feature, active writers need more: archetypes. These be preconfigured skeleton planks wit' default frontmatter.\nTh' Relearrrn theme defines some few archetypes o' planks but ye be free t' define new ones t' yer lik'n. All can be used at any level o' th' documentat'n, th' only difference be'n th' layout o' th' rrrambl'n.\nPredefined Archetypes Home A Home plank be th' start'n plank o' yer project. It’s best t' have only one plank o' this kind 'n yer project.\nT' create a home plank, run th' follow'n command\nhugo new --kind home _index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"home\" title = \"{{ replace .Name \"-\" \" \" | title }}\" +++ Lorem Ipsum.Chapter 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 below it.\nT' create a chapter plank, run th' follow'n command\nhugo new --kind chapter \u003cname\u003e/_index.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ archetype = \"chapter\" title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number. Because this number will be used t' generate th' subtitle o' th' chapter plank, set th' number t' a consecutive value start'n at 1 fer each new chapter level.\nDefault A Default plank be any other rrrambl'n plank. If ye set an unknown archetype 'n yer frontmatter, this archetype will be used t' generate th' plank.\nT' create a default plank, run either one o' th' follow'n commands\nhugo new \u003cchapter\u003e/\u003cname\u003e/_index.mdor\nhugo new \u003cchapter\u003e/\u003cname\u003e.mdThis leads t' a file wit' th' follow'n rrrambl'n\n+++ title = \"{{ replace .Name \"-\" \" \" | title }}\" weight = X +++ Lorem Ipsum.Replace th' X wit' a number or delete th' whole weight parameter entirely.\nSelf defined Archetypes If ye be 'n need o' further archetypes ye can define yer own or even redefine exist'n ones.\nTemplate Define a template file 'n yer project at archetypes/\u003ckind\u003e.md an' make sure it has at least th' frontmatter parameter fer that archetype like\n+++ archetype = \"\u003ckind\u003e\" +++Afterwards ye can generate new rrrambl'n files o' that kind wit' th' follow'n command\nhugo new --kind \u003ckind\u003e \u003cname\u003e/_index.mdPartials T' define how yer archetypes be rendered, define correspond'n partial files 'n yer projects directory layouts/partials/archetypes/\u003ckind\u003e.\nIf ye use an unknown archetype 'n yer frontmatter, th' default archetype will be used t' generate th' plank.\nRelated t' each archetype, several hook partial files 'n th' form o' \u003chook\u003e.html can be given inside each archetype directory. If a partial fer a specific hook be miss'n, no output be generated fer this hook.\nTh' follow'n hooks be used:\nName Notes styleclass Defines a set o' CSS classes t' be added t' th' HTML’s \u003cmain\u003e element. Ye can use these classes t' define own CSS rules 'n yer custom-header.html article Defines th' HTML how t' render yer rrrambl'n Take a look at th' exist'n archetypes o' this theme t' get an idea how t' utilize it.\nOutput formats Each hook file can be overridden o' a specific output format. Eg. if ye define a new output format PLAINTEXT 'n yer config.toml, ye can add a file layouts/partials/archetypes/default.plaintext.html t' change th' way how normal rrrambl'n be written fer that output format.\n", "description": "", - "tags": [ - "Content" - ], - "title": "Marrrkdown rules", - "uri": "/pir/cont/markdown/index.html" + "tags": null, + "title": "Arrrchetypes", + "uri": "/pir/cont/archetypes/index.html" }, { "breadcrumb": "", @@ -75,6 +73,16 @@ var relearn_search_index = [ "title": "Development", "uri": "/pir/dev/index.html" }, + { + "breadcrumb": "Rambl'n", + "content": " Let’s face it: Writ'n rrrambl'n fer th' web be tiresome. WYSIWYG editors help alleviate this task, but they generally result 'n horr'ble code, or worse yet, ugly web planks.\nMarrrkdown be a better way t' write HTML, without all th' complexities an' ugliness that usually accompanies it.\nSome o' th' key benefits be:\nMarrrkdown be simple t' learn, wit' minimal extra characters so it’s also quicker t' write rrrambl'n. Less chance o' errors when writ'n 'n Marrrkdown. Produces valid HTML output. Keeps th' rrrambl'n an' th' visual display separate, so ye cannot mess up th' look o' yer ship. Write 'n any text editor or Marrrkdown applicat'n ye like. Marrrkdown be a joy t' use! John Gruber, th' author o' Marrrkdown, puts it like this:\nTh' overrid'n design goal fer Markdown’s formatt'n rules be t' make it as read'ble as poss'ble. Th' idea be that a Markdown-formatted document should be publish'ble as-is, as plain text, without look'n like it’s been marked up wit' tags or formatt'n instruct'ns. While Markdown’s rules has been influenced by several exist'n text-to-HTML filters, th' single biggest source o' inspirat'n fer Markdown’s rules be th' format o' plain text email. John Gruber\nWithout further delay, let us go over th' main elements o' Marrrkdown an' what th' result'n HTML looks like:\nSmarrrt Arrrse Bookmark this plank an' th' official Commonmark reference fer easy future reference!\nParagraphs In Marrrkdown yer rrrambl'n usually spans th' whole avail'ble document width. This be called a block. Blocks be always separated by whitespace t' their adjacent blocks 'n th' result'n document.\nAny text not start'n wit' a special sign be written as normal, plain text paragraph block an' must be separated t' its adjacent blocks by empty lines.\nLorem 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. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt 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.\nHead'ns A bloody idea be t' structure yer rrrambl'n us'n head'ns an' subhead'ns. HTML-head'ns from h1 through h6 be constructed wit' a # fer each level.\nIn Hugo ye usually don’t use h1 as this be generated by yer theme an' ye should only have one such element 'n a document.\n# h1 Head'n ## h2 Head'n ### h3 Head'n #### h4 Head'n ##### h5 Head'n ###### h6 Head'n Result h1 Head'n h2 Head'n h3 Head'n h4 Head'n h5 Head'n h6 Head'n Horizontal Rules T' further structure yer rrrambl'n ye can add horizontal rules. They create a “thematic break” between paragraph blocks. In Marrrkdown, ye can create it wit' three consecutive dashes ---.\nLorem 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. Result Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.\nEt 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.\nText Markers Bold Ye can show importance o' a snippet o' text wit' a heavier font-weight by enclos'n it wit' two asterisks **.\nI am rendered wit' **bold text** Result I am rendered wit' bold text\nItalics Ye can emphasize a snippet o' text wit' italics by enclos'n it wit' underscores _.\nI am rendered wit' _italicized text_ Result I am rendered wit' italicized text\nStrikethrough In GFM (GitHub Flavored Markdown) ye can do strikethroughs by enclos'n text wit' two tildes ~~.\n~~Strike through this text~~ Result Strike through this text\nText substitut'n This Marrrkdown dialect supports an extension t' combine multiple punctuat'n characters t' single typographic entities. This will only be applied t' text outside o' code blocks or inline code.\nDo'ble quotes `\"` an' single quotes `'` o' enclosed text be replaced by **\"do'ble curly quotes\"** an' **'single curly quotes'**. Do'ble dashes `--` an' triple dashes `---` be replaced by en-dash **--** an' em-dash **---** entities. Do'ble arrows point'n left `\u003c\u003c` or right `\u003e\u003e` be replaced by arrow **\u003c\u003c** an' **\u003e\u003e** entities. Three consecutive dots `...` be replaced by an ellipsis **...** entity. Result Do'ble quotes \" an' single quotes ' o' enclosed text be replaced by “do'ble curly quotes” an' ‘single curly quotes’.\nDo'ble dashes -- an' triple dashes --- be replaced by en-dash – an' em-dash — entities.\nDo'ble arrows point'n left \u003c\u003c or right \u003e\u003e be replaced by arrow « an' » entities.\nThree consecutive dots ... be replaced by an ellipsis … entity.\nLists Unordered Ye can write a list o' items 'n which th' order o' th' items does not explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nYe may use any o' -, * or + t' denote bullets fer each list item but should not switch between those symbols inside one whole list.\n- Lorem ipsum dolor sit amet - Consectetur adipisc'n elit - Vestibulum laoreet porttitor sem - Ac tristique libero volutpat at - Nulla volutpat aliquam velit - Phasellus iaculis neque - Purus sodales ultricies - Faucibus porta lacus fringilla vel Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Vestibulum laoreet porttitor sem Ac tristique libero volutpat at Nulla volutpat aliquam velit Phasellus iaculis neque Purus sodales ultricies Faucibus porta lacus fringilla vel Ordered Ye can create a list o' items 'n which th' order o' items does explicitly matter.\nIt be poss'ble t' nest lists by indent'n an item fer th' next sublevel.\nMarrrkdown will automatically number each o' yer items consecutively. This means, th' order number ye be provid'n be irrelevant.\n1. Lorem ipsum dolor sit amet 3. Consectetur adipisc'n elit 1. Integer molestie lorem at massa 7. Facilisis 'n pretium nisl aliquet 99. Nulla volutpat aliquam velit 1. Faucibus porta lacus fringilla vel 1. Aenean sit amet erat nunc 17. Eget porttitor lorem Result Lorem ipsum dolor sit amet Consectetur adipisc'n elit Integer molestie lorem at massa Facilisis 'n pretium nisl aliquet Nulla volutpat aliquam velit Faucibus porta lacus fringilla vel Aenean sit amet erat nunc Eget porttitor lorem Tasks In GFM (GitHub Flavored Markdown) ye can add task lists result'n 'n checked or unchecked non-click'ble items\n- [x] Basic Test - [ ] More Tests - [x] View - [x] Hear - [ ] Smell Result Basic Test More Tests View Hear Smell Definit'ns This Marrrkdown dialect supports an extension t' add definit'n lists. Definit'n lists be made o' terms an' definit'ns o' these terms, much like 'n a dictionary.\nA definit'n list 'n Marrrkdown Extra be made o' a single-line term followed by a colon an' th' definit'n fer that term. Ye can also associate more than one term t' a definit'n.\nIf ye add empty lines around th' definit'n terms, additional vertical space will be generated. Also multiple paragraphs be poss'ble\nApple : Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. : An American computer company. Orange : Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it. : A telecommunicat'n company. Ye can't make juice out o' it. Result Apple Pomaceous fruit o' plants o' th' genus Malus 'n th' family Rosaceae. An American computer company. Orange Th' fruit o' an evergreen tree o' th' genus Citrus. Ye can make juice out o' it.\nA telecommunicat'n company. Ye can’t make juice out o' it.\nCode Inline Code Inline snippets o' code can be wrapped wit' backticks `.\nIn this example, `\u003cdiv\u003e\u003c/div\u003e` be marked as code. Result In this example, \u003cdiv\u003e\u003c/div\u003e be marked as code.\nIndented Code Block A simple code block can be generated by indent'n several lines o' code by at least two spaces.\nBe impressed by my advanced code: // Some comments line 1 o' code line 2 o' code line 3 o' code Result Be impressed by my advanced code:\n// Some comments line 1 o' code line 2 o' code line 3 o' code Fenced Code Block If ye want t' gain more control o' yer code block ye can enclose yer code by at least three backticks ``` a so called fence.\nIn GFM (GitHub Flavored Markdown) ye can also add a language specifier directly after th' open'n fence, ```js, an' rules highlight'n will automatically be applied accord'n t' th' selected language 'n th' rendered HTML.\nSee Code Highlight'n fer additional documentat'n.\n```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'] } } } }; ``` Result 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 In GFM (GitHub Flavored Markdown) ye can create tables 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.\n| 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. | Result 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. Aligned Columns Add'n a colon on th' left and/or right side o' th' dashes below any head'n will align th' text fer that column accordingly.\n| Opt'n | Number | Descript'n | |-------:|:------:|:------------| | data | 1 | path t' data files t' supply th' data that will be passed into templates. | | engine | 2 | engine t' be used fer process'n templates. Handlebars be th' default. | | ext | 3 | extension t' be used fer dest files. | Result Opt'n Number Descript'n data 1 path t' data files t' supply th' data that will be passed into templates. engine 2 engine t' be used fer process'n templates. Handlebars be th' default. ext 3 extension t' be used fer dest files. Blockquotes For quot'n blocks o' rrrambl'n from another source within yer document add \u003e before any text ye want t' quote.\nBlockquotes can also be nested.\n\u003e Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi. \u003e \u003e \u003e 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. \u003e \u003e Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus. Result Donec massa lacus, ultricies a ullamcorper 'n, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.\nSed 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.\nMauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.\nLinks Autolink In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.\nThis be a link t' https://example.com. Result This be a link t' https://example.com.\nBasic Link Ye can explicitly define links 'n case ye want t' use non-absolute URLs or want t' give different text.\n[Assemble](http://assemble.io) Result Assemble\nLink wit' Tooltip For even further informat'n, ye can add an additional text, displayed 'n a tooltip on hover'n over th' link.\n[Upstage](https://github.com/upstage/ \"Visit Upstage!\") Result Upstage\nLink References Links can be simplyfied fer recurr'n reuse by us'n a reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use a link more than once 'n a document.\n[Example][somelinkID] [somelinkID]: https://example.com \"Go t' example domain\" Result Example\nFootnotes Footnotes work mostly like reference-style links. A footnote be made o' two th'ns, a marker 'n th' text that will become a superscript number an' a footnote definit'n that will be placed 'n a list o' footnotes.\nUsually th' list o' footnotes will be shown at th' end o' yer document. If we use a footnote 'n a notice box it will instead be listed at th' end o' its box.\nFootnotes can contain block elements, which means that ye can put multiple paragraphs, lists, blockquotes an' so on 'n a footnote. It works th' same as fer list items, just indent th' follow'n paragraphs by four spaces 'n th' footnote definit'n.\nThat's some text wit' a footnote[^1] [^1]: An' that's th' footnote. That's some more text wit' a footnote.[^someid] [^someid]: Anyth'n o' interest goes here. Blue light glows blue. Result That’s some text wit' a footnote1\nThat’s some more text wit' a footnote.2\nAn' that’s th' footnote. ↩︎\nAnyth'n o' interest goes here.\nBlue light glows blue. ↩︎\nImages Basic Images Images have a similar rules t' links but include a preced'n exclamat'n mark.\n![Spock](https://octodex.github.com/images/spocktocat.png) Result Image wit' Tooltip Like links, images can also be given a tooltip.\n![Picard](https://octodex.github.com/images/jean-luc-picat.jpg \"Jean Luc Picard\") Result Image References Images can also be linked by reference ID t' later define th' URL locat'n. This simplyfies writ'n if ye want t' use an image more than once 'n a document.\n![La Forge][laforge] [laforge]: https://octodex.github.com/images/trekkie.jpg \"Geordi La Forge\" Result Image Effects This theme allows additional non-standard formatt'n by sett'n query parameter at th' end o' th' image URL. Th' default behavior be configur'ble thru yer config.toml or frontmatter parameter.\nResiz'n Add query parameter width and/or height t' th' link image t' resize th' image. Values be CSS values (default be auto).\n![Minion](https://octodex.github.com/images/minion.png?width=20vw) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px) Result ![Minion](https://octodex.github.com/images/minion.png?height=50px\u0026width=40vw) Result CSS Classes Add a query parameter classes t' th' link image t' add CSS classes. Add some o' th' predefined values or even define yer own 'n yer CSS.\nShadow ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=shadow) Result Border ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=border) Result Left ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=left) Result Right ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=right) Result Inline ![Spidertocat](https://octodex.github.com/images/spidertocat.png?classes=inline) ![DrOctocat](https://octodex.github.com/images/droctocat.png?classes=inline) ![Supertocat](https://octodex.github.com/images/okal-eltocat.jpg?classes=inline) ![Riddlocat](https://octodex.github.com/images/riddlocat.jpg?classes=inline) Result Combinat'n ![X-tocat](https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left) Result Lightbox Add th' query parameter lightbox=false t' th' image link t' dis'ble th' lightbox.\n![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false) Result Avast If ye want t' wrap an image 'n a link an' lightbox=true be yer default sett'n, ye have t' explicitly dis'ble th' lightbox t' avoid it t' hijack'n yer link like:\n[![Homercat](https://octodex.github.com/images/homercat.png?lightbox=false)](https://octodex.github.com/#homercat)\n", + "description": "", + "tags": [ + "Content" + ], + "title": "Marrrkdown rules", + "uri": "/pir/cont/markdown/index.html" + }, { "breadcrumb": "Rambl'n", "content": " Th' theme supports non-standard image effects.\nAs described, ye can add this t' th' URL query parameter, but this may be cumbersome t' do it consistently fer th' whole plank.\nInstead, ye can configure th' defaults 'n yer config.toml aswell as overrid'n these default 'n th' planks frontmatter.\nExplicitly set URL query parameter will override th' defaults 'n effect fer a plank.\nWithout any sett'ns 'n yer config.toml this defaults t'\n​ config.toml [params] [params.imageEffects] border = false lightbox = true shadow = false This can be overridden 'n a planks frontmatter by eg.\n​ frontmatter +++ [imageEffects] border = true +++ Or by explicitly override sett'ns by URL query parameter\n​ URL ![Minion](https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true) Th' sett'ns applied t' th' above image would be\n​ Result border = true lightbox = false shadow = false bg-white = true This ends up 'n th' follow'n HTML whar' th' parameter be converted t' CSS classes.\n​ HTML \u003cimg src=\"https://octodex.github.com/images/minion.png?lightbox=false\u0026bg-white=true\" alt=\"Minion\" class=\"bg-white border nolightbox noshadow\"\u003e Extend'n As ye can see 'n th' above example, th' bg-white parameter be not initially supported 'n th' themes default sett'ns. Nevertheless ye be free t' define arbitrary parameter by just add'n them t' th' URL query parameter or set them 'n yer config.toml or planks frontmatter.\nAvast If no extended parameter like bg-white 'n th' example be set on th' URL, a class=\"nobg-white\" 'n th' HTML will only be generated if a default value was set 'n th' config.toml or planks frontmatter.\n", @@ -138,7 +146,7 @@ var relearn_search_index = [ }, { "breadcrumb": "Basics", - "content": " On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer config.toml. Th' defaults be written 'n th' comments o' each opt'n.\nAvast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n.\n​ config.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' author o' yer ship. # Default: not set # This will be used 'n HTML meta tags, th' opengraph protocol an' twitter # cards. # Ye can also set `author.email` if ye want t' publish this informat'n. author.name = \"Sören Weber\" # Th' social media image o' yer ship. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. images = [ \"images/hero.png\" ] # Th' descript'n o' yer ship. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. descript'n = \"Documentat'n fer Cap'n Hugo Relearrrn Theme\" # Admin opt'ns fer social media. # Default: not set # Configurat'n fer th' Open Graph protocol an' Twitter Cards adhere t' Hugo's # implementat'n. See th' Cap'n Hugo docs fer poss'ble values. social.facebook_admin = \"\" social.twitter = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Variants # These opt'ns set yer color variant. # Used color variants. # Default: \"auto\" # This sets one or more color variants, avail'ble t' yer readers t' choose # from. Ye can # - set a single value eg. \"zen-light\" # - an array like [ \"neon\", \"learn\" ] # - an array wit' opt'ns like [ { identifier = \"neon\" },{ identifier = \"learn\" } ] # Th' last form allows t' set further opt'ns fer each variant. # Th' `identifier` be mandatory. Ye can also set `name` which overrides th' # value displayed 'n th' variant selector. # If th' array has more than one entry, a variant selector # be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th' # default variant, used fer first time visitors. # Th' theme ships wit' th' follow'n variants: \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". In addit'n ye can use auto mode variants. See th' # docs fer a detailed explainat'n. # Ye can also define yer own variants. See th' docs how this works. Also, # th' docs provide an interactive theme generator t' help ye wit' this task. themeVariant = [ { identifier = \"relearn-auto\", name = \"Relearn Light/Dark\", auto = [] }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"relearn-bright\" }, { identifier = \"zen-auto\", name = \"Zen Light/Dark\", auto = [ \"zen-light\", \"zen-dark\" ] }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These opt'ns be defin'n general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files an' CSS-files get a unique ID on each rebuild. # This makes sure, th' user always has th' latest version an' not some stale # copy o' his browser cache. Anyways, it can be desire'ble t' turn this # off 'n certain circumstances. For example if ye have Hugo's dev server # runn'n. Also some proxies dislike this optimizat'n. disableAssetsBust'n = false # Avoid generator meta tags. # Default: false # Set this t' true if ye want t' dis'ble generat'n fer generator meta tags # o' Cap'n Hugo an' th' theme 'n yer HTML head. In tihs case also don't forget t' # set Hugo's disableHugoGeneratorInject=true. Otherwise Cap'n Hugo will generate a # meta tag into yer home plank anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situat'ns th' theme generates non st'ble unique ids t' be used # 'n HTML fragment links. This can be undesir'ble fer example when test'n # th' output fer changes. If ye dis'ble th' random id generat'n, th' theme # may not funct'n correctly anymore. disableRandomIds = false # Multilanguage rrrambl'n. # Default: not set # If yer planks contain further languages besides th' main one used, add all # those auxiliary languages here. This will create a search index wit' # support fer all used languages o' yer ship. # This be handy fer example if ye be writ'n 'n Spanish but have lots o' # source code on yer plank which typically uses English terminology. additionalContentLanguage = [ \"en\" ] # Additional code dependencies. # Default: See config.toml o' th' theme # Th' theme provides a mechanism t' board further JavaScript an' CSS # dependencies on demand only if they be needed. This comes 'n handy if ye # want t' add own shorrrtcodes that depend on additional code t' be boarded. # See th' docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # This can be overridden 'n th' page's frontmatter. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false # Th' URL prefix t' edit a plank. # Default: not set # If set, an edit button will be shown 'n th' topbar. If th' button be hidden, # also th' keyboard shortcuts be disabled. Th' given URL be prepended t' th' # relative file path o' a th' displayed plank. Th' URL must end wit' a `/`. # This be useful if ye wnat t' give th' opportunity fer people t' create merge # request fer yer rrrambl'n. editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu apperance. # Hide th' search box. # Default: false # If th' searc box be sisabled, th' search functionality be disabled too. # This will also cause th' keyboard shortcut t' be disabled an' th' dedicated # search plank be not linked although it mighty be configured. disableSearch = false # Hide th' Home entry. # Default: false # If shown, a Home button will appear below th' search bar an' th' main menu. # It links t' yer th' home plank o' th' current language. disableLandingPageButton = true # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). This can be overridden 'n th' planks frontmatter. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. This can be overridden 'n th' page's frontmatter. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\" # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. collapsibleMenu = true # Shows checkmarks fer visited planks o' th' main menu. # Default: false # This also causes th' display o' th' `Clear History` entry 'n th' lower part # o' th' menu t' remove all checkmarks. Th' checkmarks will also been removed # if ye regenerate yer ship as th' ids be not st'ble. showVisitedLinks = true # Hide head'n above th' shortcut menu. # Default: false # Th' title fer th' head'n can be overwritten 'n yer i18n files. See Hugo's # documentat'n how t' do this. disableShortcutsTitle = false # Hide th' language switcher. # Default: false # If ye have more than one language configured, a language switcher be # displayed 'n th' lower part o' th' menu. This opit'n lets ye explicitly # turn this behavior off. disableLanguageSwitchingButton = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu but behaves # like any other plank fer all other functionality 'n Hugo. # Hide hidden planks from search. # Default: false # Hides hidden planks from th' suggest'ns o' th' search box an' th' dedicated # search plank. disableSearchHiddenPages = false # Hide hidden planks fer web crawlers. # Default: false # Avoids hidden planks from show'n up 'n th' sitemap an' on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden planks fer taxonomies. # Default: false # Hides hidden planks from show'n up on th' taxonomy an' terms planks. If this # reduces term counters t' zero, an empty but not linked term plank will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Title separator. # Default: \"::\" # Changes th' title separator used when concatenat'n th' plank title wit' th' # ship title. This be consistently used throughout th' theme. titleSeparator = \"::\" # Breadcrumb separator. # Default: \"\u003e\" # Changes th' breadcrumb separator used 'n th' topbars breadcrumb area an' fer # search results an' term planks. breadcrumbSeparator = \"\u003e\" # Hide th' root breadcrumb. # Default: false # Th' root breadcrumb be usually th' home plank o' yer ship. Because this be # always access'ble by click'n on th' logo, ye may want t' reduce clutter # by remov'n this from yer breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term planks. # Default: false # If ye have lots o' taxonomy terms, th' term planks may seem cluttered wit' # breadcrumbs t' ye, so this be th' opt'n t' turn off breadcrumbs on term # planks. Only th' plank title will then be shown on th' term planks. disableTermBreadcrumbs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Hide copy-to-clipboard fer inline code. # Default: false # This removes th' copy-to-clipboard button from yer inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard fer block code. # Default: false # Th' theme only shows th' copy-to-clipboard button if ye hover over th' code # block. Set this t' true t' dis'ble th' hover effect an' always show th' # button. disableHoverBlockCopyToClipBoard = false # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effects can be overridden 'n th' page's frontmatter or thru URL parameter # given t' th' image. See th' documentat'n fer details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These opt'ns configure how links be displayed. # How t' open external links. # Default: \"_blank\" # For external links ye can define how they be opened 'n yer browser. All # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th' # default value opens external links 'n a separate browser tab. If ye want # t' open those links 'n th' same tab, use \"_self\". externalLinkTarget = \"_blank\" # Generate link URLs th' Cap'n Hugo way. # Default: false # If set t' true, th' theme behaves like a standard Cap'n Hugo installat'n an' # appends no index.html t' prettyURLs. As a trade off, yer build project will # not be serv'ble from th' file system. disableExplicitIndexURLs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mathJaxInitialize = \"{}\" # Only board MathJax if needed. # Default: true # If a Math shortcode be found, th' opt'n will be ignored an' # MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMathJax = true # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only board Merrrmaid if needed. # Default: true # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMermaid = true # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Only board OpenAPI if needed. # Default: true # If a OpenAPI shortcode be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableOpenapi = true # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" ", + "content": " On top o' Hugo’s global configurat'n opt'ns, th' Relearrrn theme lets ye define further opt'ns unique t' th' theme 'n yer config.toml. Th' defaults be written 'n th' comments o' each opt'n.\nAvast that some o' these opt'ns be explained 'n detail 'n other sections o' this documentat'n.\n​ config.toml [params] # If an opt'n value be said t' be not set, ye can achieve th' same behavior # by given it an empty str'n value. ############################################################################### # Cap'n Hugo # These opt'ns usually apply t' other themes aswell. # Th' author o' yer ship. # Default: not set # This will be used 'n HTML meta tags, th' opengraph protocol an' twitter # cards. # Ye can also set `author.email` if ye want t' publish this informat'n. author.name = \"Sören Weber\" # Th' social media image o' yer ship. # Default: not set # This be used fer generat'n social media meta informat'n fer th' opengraph # protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. images = [ \"images/hero.png\" ] # Th' descript'n o' yer ship. # Default: not set # This be used fer generat'n HTML meta tags, social media meta informat'n # fer th' opengraph protocol an' twitter cards. # This can be overridden 'n th' page's frontmatter. descript'n = \"Documentat'n fer Cap'n Hugo Relearrrn Theme\" # Admin opt'ns fer social media. # Default: not set # Configurat'n fer th' Open Graph protocol an' Twitter Cards adhere t' Hugo's # implementat'n. See th' Cap'n Hugo docs fer poss'ble values. social.facebook_admin = \"\" social.twitter = \"\" ############################################################################### # Relearrrn Theme # These opt'ns be specific t' th' Relearrrn theme. #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Variants # These opt'ns set yer color variant. # Used color variants. # Default: \"auto\" # This sets one or more color variants, avail'ble t' yer readers t' choose # from. Ye can # - set a single value eg. \"zen-light\" # - an array like [ \"neon\", \"learn\" ] # - an array wit' opt'ns like [ { identifier = \"neon\" },{ identifier = \"learn\" } ] # Th' last form allows t' set further opt'ns fer each variant. # Th' `identifier` be mandatory. Ye can also set `name` which overrides th' # value displayed 'n th' variant selector. # If th' array has more than one entry, a variant selector # be shown 'n th' lower part o' th' menu. Th' first entry 'n th' array be th' # default variant, used fer first time visitors. # Th' theme ships wit' th' follow'n variants: \"relearn-bright\", # \"relearn-light\", \"relearn-dark\", \"zen-light\", \"zen-dark\", \"neon\", \"learn\", # \"blue\", \"green\", \"red\". In addit'n ye can use auto mode variants. See th' # docs fer a detailed explainat'n. # Ye can also define yer own variants. See th' docs how this works. Also, # th' docs provide an interactive theme generator t' help ye wit' this task. themeVariant = [ { identifier = \"relearn-auto\", name = \"Relearn Light/Dark\", auto = [] }, { identifier = \"relearn-light\" }, { identifier = \"relearn-dark\" }, { identifier = \"relearn-bright\" }, { identifier = \"zen-auto\", name = \"Zen Light/Dark\", auto = [ \"zen-light\", \"zen-dark\" ] }, { identifier = \"zen-light\" }, { identifier = \"zen-dark\" }, { identifier = \"neon\" }, { identifier = \"learn\" }, { identifier = \"blue\" }, { identifier = \"green\" }, { identifier = \"red\" } ] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # General # These opt'ns be defin'n general, non visual behavior. # Avoid new asset URLs on build. # Default: false # By default JavaScript-files an' CSS-files get a unique ID on each rebuild. # This makes sure, th' user always has th' latest version an' not some stale # copy o' his browser cache. Anyways, it can be desire'ble t' turn this # off 'n certain circumstances. For example if ye have Hugo's dev server # runn'n. Also some proxies dislike this optimizat'n. disableAssetsBust'n = false # Avoid generator meta tags. # Default: false # Set this t' true if ye want t' dis'ble generat'n fer generator meta tags # o' Cap'n Hugo an' th' theme 'n yer HTML head. In tihs case also don't forget t' # set Hugo's disableHugoGeneratorInject=true. Otherwise Cap'n Hugo will generate a # meta tag into yer home plank anyways. disableGeneratorVersion = false # Avoid unique IDs. # Default: false # In various situat'ns th' theme generates non st'ble unique ids t' be used # 'n HTML fragment links. This can be undesir'ble fer example when test'n # th' output fer changes. If ye dis'ble th' random id generat'n, th' theme # may not funct'n correctly anymore. disableRandomIds = false # Multilanguage rrrambl'n. # Default: not set # If yer planks contain further languages besides th' main one used, add all # those auxiliary languages here. This will create a search index wit' # support fer all used languages o' yer ship. # This be handy fer example if ye be writ'n 'n Spanish but have lots o' # source code on yer plank which typically uses English terminology. additionalContentLanguage = [ \"en\" ] # Additional code dependencies. # Default: See config.toml o' th' theme # Th' theme provides a mechanism t' board further JavaScript an' CSS # dependencies on demand only if they be needed. This comes 'n handy if ye # want t' add own shorrrtcodes that depend on additional code t' be boarded. # See th' docs how this works. # [relearn.dependencies] #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Topbar # These opt'ns modify th' topbar appearance. # Hide th' t'ble o' contents button. # Default: false # If th' TOC button be hidden, also th' keyboard shortcut be disabled. # This can be overridden 'n th' page's frontmatter. disableToc = false # Hide th' breadcrumbs. # Default: false # If th' breadcrumbs be hidden, th' title o' th' displayed plank will still be # shown 'n th' topbar. disableBreadcrumb = false # Hide Next an' Previous navigat'n buttons. # Default: false # If th' navigat'n buttons be hidden, also th' keyboard shortcuts be # disabled. disableNextPrev = false # Th' URL prefix t' edit a plank. # Default: not set # If set, an edit button will be shown 'n th' topbar. If th' button be hidden, # also th' keyboard shortcuts be disabled. Th' given URL be prepended t' th' # relative file path o' a th' displayed plank. Th' URL must end wit' a `/`. # This be useful if ye wnat t' give th' opportunity fer people t' create merge # request fer yer rrrambl'n. editURL = \"https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Menu # These opt'ns modify th' menu apperance. # Hide th' search box. # Default: false # If th' searc box be sisabled, th' search functionality be disabled too. # This will also cause th' keyboard shortcut t' be disabled an' th' dedicated # search plank be not linked although it mighty be configured. disableSearch = false # Hide th' Home entry. # Default: false # If shown, a Home button will appear below th' search bar an' th' main menu. # It links t' yer th' home plank o' th' current language. disableLandingPageButton = true # Th' order o' main menu submenus. # Default: \"weight\" # Submenus can be ordered by \"weight\", \"title\", \"linktitle\", \"modifieddate\", # \"expirydate\", \"publishdate\", \"date\", \"length\" or \"default\" (adher'n t' # Hugo's default sort order). This can be overridden 'n th' planks frontmatter. ordersectionsby = \"weight\" # Th' initial expand state o' submenus. # Default: not set # This controls whether submenus will be expanded (true), or collapsed (false) # 'n th' menu. If not set, th' first menu level be set t' false, all others # levels be set t' true. This can be overridden 'n th' page's frontmatter. # If th' displayed plank has submenus, they will always been displayed expanded # regardless o' this opt'n. alwaysopen = \"\" # Shows expander fer submenus. # Default: false # If set t' true, a submenu 'n th' sidebar will be displayed 'n a collaps'ble # tree view an' a click'ble expander be set 'n front o' th' entry. collapsibleMenu = true # Shows checkmarks fer visited planks o' th' main menu. # Default: false # This also causes th' display o' th' `Clear History` entry 'n th' lower part # o' th' menu t' remove all checkmarks. Th' checkmarks will also been removed # if ye regenerate yer ship as th' ids be not st'ble. showVisitedLinks = true # Hide head'n above th' shortcut menu. # Default: false # Th' title fer th' head'n can be overwritten 'n yer i18n files. See Hugo's # documentat'n how t' do this. disableShortcutsTitle = false # Hide th' language switcher. # Default: false # If ye have more than one language configured, a language switcher be # displayed 'n th' lower part o' th' menu. This opit'n lets ye explicitly # turn this behavior off. disableLanguageSwitchingButton = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Hidden planks # These opt'ns configure how hidden planks be treated. # A plank flagged as hidden, be only removed from th' main menu if ye be # currently not on this plank or th' hidden plank be not part o' current page's # ancestors. For all other functionality 'n Hugo a hidden plank behaves like any # other plank if not otherwise configured. # Hide hidden planks from search. # Default: false # Hides hidden planks from th' suggest'ns o' th' search box an' th' dedicated # search plank. disableSearchHiddenPages = false # Hide hidden planks fer web crawlers. # Default: false # Avoids hidden planks from show'n up 'n th' sitemap an' on Google (et all), # otherwise they may be indexed by search engines disableSeoHiddenPages = true # Hide hidden planks fer taxonomies. # Default: false # Hides hidden planks from show'n up on th' taxonomy an' terms planks. If this # reduces term counters t' zero, an empty but not linked term plank will be # created anyhow. disableTagHiddenPages = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Rrrambl'n # These opt'ns modify how yer rrrambl'n be displayed. # Title separator. # Default: \"::\" # Changes th' title separator used when concatenat'n th' plank title wit' th' # ship title. This be consistently used throughout th' theme. titleSeparator = \"::\" # Breadcrumb separator. # Default: \"\u003e\" # Changes th' breadcrumb separator used 'n th' topbars breadcrumb area an' fer # search results an' term planks. breadcrumbSeparator = \"\u003e\" # Hide th' root breadcrumb. # Default: false # Th' root breadcrumb be usually th' home plank o' yer ship. Because this be # always access'ble by click'n on th' logo, ye may want t' reduce clutter # by remov'n this from yer breadcrumb. disableRootBreadcrumb = true # Hide breadcrumbs term planks. # Default: false # If ye have lots o' taxonomy terms, th' term planks may seem cluttered wit' # breadcrumbs t' ye, so this be th' opt'n t' turn off breadcrumbs on term # planks. Only th' plank title will then be shown on th' term planks. disableTermBreadcrumbs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Highlight # These opt'ns configure how code be displayed. # Hide copy-to-clipboard fer inline code. # Default: false # This removes th' copy-to-clipboard button from yer inline code. disableInlineCopyToClipBoard = true # Always show copy-to-clipboard fer block code. # Default: false # Th' theme only shows th' copy-to-clipboard button if ye hover over th' code # block. Set this t' true t' dis'ble th' hover effect an' always show th' # button. disableHoverBlockCopyToClipBoard = false # Wrap fer code blocks. # Default: true # By default lines o' code blocks wrap around if th' line be too long t' be # displayed on screen. If ye dislike this behavior, ye can reconfigure it # here. # Avast that lines always wrap 'n print mode regardless o' this opt'n. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual code blocks. highlightWrap = true #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Images # These opt'ns configure how images be displayed. # Image effects. # See th' documentat'n fer how ye can even add yer own arbitrary effects t' # th' list. # All effects can be overridden 'n th' page's frontmatter or thru URL parameter # given t' th' image. See th' documentat'n fer details. # Default: false imageEffects.border = true # Default: true imageEffects.lightbox = true # Default: false imageEffects.shadow = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Links # These opt'ns configure how links be displayed. # How t' open external links. # Default: \"_blank\" # For external links ye can define how they be opened 'n yer browser. All # values fer th' HTML `target` attribute o' th' `a` element be allowed. Th' # default value opens external links 'n a separate browser tab. If ye want # t' open those links 'n th' same tab, use \"_self\". externalLinkTarget = \"_blank\" # Generate link URLs th' Cap'n Hugo way. # Default: false # If set t' true, th' theme behaves like a standard Cap'n Hugo installat'n an' # appends no index.html t' prettyURLs. As a trade off, yer build project will # not be serv'ble from th' file system. disableExplicitIndexURLs = false #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # MathJax # These opt'ns configure how math formulae be displayed. # Initializat'n opt'ns fer MathJax. # Default: not set # A JSON value. See th' MathJaxdocumentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mathJaxInitialize = \"{}\" # Only board MathJax if needed. # Default: true # If a Math shortcode be found, th' opt'n will be ignored an' # MathJax will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMathJax=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMathJax = true # URL fer external MathJax library. # Default: not set # Specifies th' remote locat'n o' th' MathJax library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMathJaxURL = \"\" # \"https://unpkg.com/mathjax/es5/tex-mml-chtml.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # Merrrmaid # These opt'ns configure how Merrrmaid graphs be displayed. # Make graphs pan'ble an' zoom'ble # Default: false # For huge graphs it can be helpful t' make them zoom'ble. Zoom'ble graphs come # wit' a reset button fer th' zoom. # This can be overridden 'n th' page's frontmatter or given as a parameter t' # individual graphs. mermaidZoom = true # Initializat'n opt'ns fer Merrrmaid. # Default: not set # A JSON value. See th' Merrrmaid documentat'n fer poss'ble parameter. # This can be overridden 'n th' page's frontmatter. mermaidInitialize = \"{ \\\"securityLevel\\\": \\\"loose\\\" }\" # Only board Merrrmaid if needed. # Default: true # If a Merrrmaid shortcode or codefence be found, th' opt'n will be ignored an' # Merrrmaid will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableMermaid=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableMermaid = true # URL fer external Merrrmaid library. # Default: not set # Specifies th' remote locat'n o' th' Merrrmaid library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customMermaidURL = \"\" # \"https://unpkg.com/mermaid/dist/mermaid.min.js\" #++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ # OpenApi # These opt'ns configure how OpenAPI specificat'ns be displayed. # Only board OpenAPI if needed. # Default: true # If a OpenAPI shortcode be found, th' opt'n will be ignored an' # OpenAPI will be boarded regardlessly. Th' opt'n be still useful 'n case ye # be us'n script'n t' set up yer graph. In this case no shortcode or # codefence be involved an' th' library be not boarded by default. In this case # ye can set `disableOpenapi=false` 'n yer frontmatter t' force th' library t' # be boarded. # This can be overridden 'n th' page's frontmatter. disableOpenapi = true # URL fer external OpenAPI library. # Default: not set # Specifies th' remote locat'n o' th' OpenAPI library. By default th' shipped # version will be used. # This can be overridden 'n th' page's frontmatter. customOpenapiURL = \"\" # \"https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js\" ", "description": "", "tags": [ "config" diff --git a/pir/more/credits/index.html b/pir/more/credits/index.html index be63ee0d4c..d5afa0eb25 100644 --- a/pir/more/credits/index.html +++ b/pir/more/credits/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/more/credits/index.print.html b/pir/more/credits/index.print.html index b7a762cabf..bb486fb9b2 100644 --- a/pir/more/credits/index.print.html +++ b/pir/more/credits/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/search.html b/pir/search.html index a68b79f6be..f2a54a1e67 100644 --- a/pir/search.html +++ b/pir/search.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/attachments/index.html b/pir/shortcodes/attachments/index.html index 92ec264ecb..83e733894c 100644 --- a/pir/shortcodes/attachments/index.html +++ b/pir/shortcodes/attachments/index.html @@ -26,21 +26,21 @@ Attachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Ca - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/attachments/index.print.html b/pir/shortcodes/attachments/index.print.html index 74642b7d76..86e23e4420 100644 --- a/pir/shortcodes/attachments/index.print.html +++ b/pir/shortcodes/attachments/index.print.html @@ -26,22 +26,22 @@ Attachments adivorciarsetoca00cape.pdf (361 KB) BachGavotteShort.mp3 (357 KB) Ca - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/badge/index.html b/pir/shortcodes/badge/index.html index cff52b4639..633c8a57ad 100644 --- a/pir/shortcodes/badge/index.html +++ b/pir/shortcodes/badge/index.html @@ -30,21 +30,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/badge/index.print.html b/pir/shortcodes/badge/index.print.html index 843cf0060c..e5791904bb 100644 --- a/pir/shortcodes/badge/index.print.html +++ b/pir/shortcodes/badge/index.print.html @@ -30,22 +30,22 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/button/index.html b/pir/shortcodes/button/index.html index 343a04792e..ea3b945fdd 100644 --- a/pir/shortcodes/button/index.html +++ b/pir/shortcodes/button/index.html @@ -28,21 +28,21 @@ Get Cap'n Hugo Get Cap'n Hugo Usage While th' examples be us'n s - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/button/index.print.html b/pir/shortcodes/button/index.print.html index 40e48e118a..095c8ddf52 100644 --- a/pir/shortcodes/button/index.print.html +++ b/pir/shortcodes/button/index.print.html @@ -28,22 +28,22 @@ Get Cap'n Hugo Get Cap'n Hugo Usage While th' examples be us'n s - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + 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 8de79f85bf..4384fea198 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 @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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.print.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.print.html index 204020fc6c..688deec5ac 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.print.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.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + 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 2b323a69d6..f2093e9fba 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 @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + 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.print.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.print.html index cff83de493..4892f0c23a 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.print.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.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + 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 d9dde5b310..e9b22f4b2d 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 @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html index f28f14422b..7042305ce5 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + 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 528a33bb84..11466c207b 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 @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html index 212c2f9b3a..b401a63617 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-1/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + 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 1c6ad2c2e0..c6eaf0c247 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 @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html index 3cc78b069e..4d9f5949d2 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + 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 4780e60f76..631f582b04 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 @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html index 88a9744721..16310eec1e 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + 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 5336ec4134..a13132ba47 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 @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html index c18850c360..dfa46704e3 100644 --- a/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/children-1-1-3/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + 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 db5c3e5a3d..c6bfb778eb 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.html +++ b/pir/shortcodes/children/children-1/children-1-1/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/children-1-1/index.print.html b/pir/shortcodes/children/children-1/children-1-1/index.print.html index 5ffbee04bc..2dc250f749 100644 --- a/pir/shortcodes/children/children-1/children-1-1/index.print.html +++ b/pir/shortcodes/children/children-1/children-1-1/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-1/index.html b/pir/shortcodes/children/children-1/index.html index 17b38ba81c..14992c5892 100644 --- a/pir/shortcodes/children/children-1/index.html +++ b/pir/shortcodes/children/children-1/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-1/index.print.html b/pir/shortcodes/children/children-1/index.print.html index e4fd8fd951..bc58ea0352 100644 --- a/pir/shortcodes/children/children-1/index.print.html +++ b/pir/shortcodes/children/children-1/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-2/index.html b/pir/shortcodes/children/children-2/index.html index 9356f0204b..8ebb51d193 100644 --- a/pir/shortcodes/children/children-2/index.html +++ b/pir/shortcodes/children/children-2/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-2/index.print.html b/pir/shortcodes/children/children-2/index.print.html index 2436c40ee5..f8806cd669 100644 --- a/pir/shortcodes/children/children-2/index.print.html +++ b/pir/shortcodes/children/children-2/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-3/index.html b/pir/shortcodes/children/children-3/index.html index 4721552db5..ba00c75194 100644 --- a/pir/shortcodes/children/children-3/index.html +++ b/pir/shortcodes/children/children-3/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-3/index.print.html b/pir/shortcodes/children/children-3/index.print.html index 41fc37b554..a8dcf23500 100644 --- a/pir/shortcodes/children/children-3/index.print.html +++ b/pir/shortcodes/children/children-3/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-3/test3/index.html b/pir/shortcodes/children/children-3/test3/index.html index 0082aa0619..ba5d4616e5 100644 --- a/pir/shortcodes/children/children-3/test3/index.html +++ b/pir/shortcodes/children/children-3/test3/index.html @@ -24,21 +24,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-3/test3/index.print.html b/pir/shortcodes/children/children-3/test3/index.print.html index 736a65bdb2..340f77be10 100644 --- a/pir/shortcodes/children/children-3/test3/index.print.html +++ b/pir/shortcodes/children/children-3/test3/index.print.html @@ -24,22 +24,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/children-4/index.html b/pir/shortcodes/children/children-4/index.html index 97ee4a1c7b..61fa744221 100644 --- a/pir/shortcodes/children/children-4/index.html +++ b/pir/shortcodes/children/children-4/index.html @@ -22,21 +22,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/children-4/index.print.html b/pir/shortcodes/children/children-4/index.print.html index 3cf43a9c42..dd8ed90de5 100644 --- a/pir/shortcodes/children/children-4/index.print.html +++ b/pir/shortcodes/children/children-4/index.print.html @@ -22,22 +22,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/index.html b/pir/shortcodes/children/index.html index 325aaf606b..d923ac0f05 100644 --- a/pir/shortcodes/children/index.html +++ b/pir/shortcodes/children/index.html @@ -23,21 +23,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/index.print.html b/pir/shortcodes/children/index.print.html index 9ddc8bd243..7c552a317b 100644 --- a/pir/shortcodes/children/index.print.html +++ b/pir/shortcodes/children/index.print.html @@ -23,22 +23,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/children/test/index.html b/pir/shortcodes/children/test/index.html index feb9b29799..5a4af7f645 100644 --- a/pir/shortcodes/children/test/index.html +++ b/pir/shortcodes/children/test/index.html @@ -27,21 +27,21 @@ - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + + - - - + + + diff --git a/pir/shortcodes/children/test/index.print.html b/pir/shortcodes/children/test/index.print.html index 7ef0a5abf9..b711001a6d 100644 --- a/pir/shortcodes/children/test/index.print.html +++ b/pir/shortcodes/children/test/index.print.html @@ -27,22 +27,22 @@ - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - - + + + diff --git a/pir/shortcodes/expand/index.html b/pir/shortcodes/expand/index.html index e70ae1a194..d6095752ba 100644 --- a/pir/shortcodes/expand/index.html +++ b/pir/shortcodes/expand/index.html @@ -40,21 +40,21 @@ Usage While th' examples be us'n shorrrtcodes wit' named parameter y - + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - + + + + + +
  • Historrry
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Rambl'n
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content
  • 2. Content