First batch of day one
This commit is contained in:
@@ -0,0 +1,7 @@
|
||||
+++
|
||||
archetype = "chapter"
|
||||
title = "Content"
|
||||
weight = 2
|
||||
+++
|
||||
|
||||
Find out how to create and organize your content quickly and intuitively.
|
||||
@@ -0,0 +1,6 @@
|
||||
+++
|
||||
archetype = "chapter"
|
||||
title = "Rambl'n"
|
||||
weight = 2
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,128 @@
|
||||
+++
|
||||
title = "Archetypes"
|
||||
weight = 3
|
||||
+++
|
||||
|
||||
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](https://gohugo.io/content/archetypes/). These are preconfigured skeleton pages with default frontmatter.
|
||||
|
||||
The Relearn theme defines some few archetypes of pages but you are free to define new ones to your liking. All can be used at any level of the documentation, the only difference being the layout of the content.
|
||||
|
||||
## Predefined Archetypes
|
||||
|
||||
### Home {#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.
|
||||
|
||||
|
||||
|
||||
To create a home page, run the following command
|
||||
|
||||
````shell
|
||||
hugo new --kind home _index.md
|
||||
````
|
||||
|
||||
This leads to a file with the following content
|
||||
|
||||
````toml {title="_index.md"}
|
||||
+++
|
||||
archetype = "home"
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
+++
|
||||
|
||||
Lorem Ipsum.
|
||||
````
|
||||
|
||||
### Chapter {#archetypes-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.
|
||||
|
||||
|
||||
|
||||
To create a chapter page, run the following command
|
||||
|
||||
````shell
|
||||
hugo new --kind chapter <name>/_index.md
|
||||
````
|
||||
|
||||
This leads to a file with the following content
|
||||
|
||||
````toml {title="_index.md"}
|
||||
+++
|
||||
archetype = "chapter"
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
weight = 1
|
||||
+++
|
||||
|
||||
Lorem Ipsum.
|
||||
````
|
||||
|
||||
The `weight` 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.
|
||||
|
||||
### Default {#archetypes-default}
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
To create a default page, run either one of the following commands
|
||||
|
||||
````shell
|
||||
hugo new <chapter>/<name>/_index.md
|
||||
````
|
||||
|
||||
or
|
||||
|
||||
````shell
|
||||
hugo new <chapter>/<name>.md
|
||||
````
|
||||
|
||||
This leads to a file with the following content
|
||||
|
||||
````toml {title="*.md"}
|
||||
+++
|
||||
title = "{{ replace .Name "-" " " | title }}"
|
||||
+++
|
||||
|
||||
Lorem Ipsum.
|
||||
````
|
||||
|
||||
## Self defined Archetypes
|
||||
|
||||
If you are in need of further archetypes you can define your own or even redefine existing ones.
|
||||
|
||||
### Template
|
||||
|
||||
Define a template file in your project at `archetypes/<kind>.md` and make sure it has at least the frontmatter parameter for that archetype like
|
||||
|
||||
````toml {title="<kind>.md"}
|
||||
+++
|
||||
archetype = "<kind>"
|
||||
+++
|
||||
````
|
||||
|
||||
Afterwards you can generate new content files of that kind with the following command
|
||||
|
||||
````shell
|
||||
hugo new --kind <kind> <name>/_index.md
|
||||
````
|
||||
|
||||
### Partials
|
||||
|
||||
To define how your archetypes are rendered, define corresponding partial files in your projects directory `layouts/partials/archetypes/<kind>`.
|
||||
|
||||
If you use an unknown archetype in your frontmatter, the `default` archetype will be used to generate the page.
|
||||
|
||||
Related to each archetype, several _hook_ partial files in the form of `<hook>.html` can be given inside each archetype directory. If a partial for a specific hook is missing, no output is generated for this hook.
|
||||
|
||||
The following hooks are used:
|
||||
|
||||
| Name | Notes |
|
||||
|----------------------|-------------|
|
||||
| styleclass | Defines a set of CSS classes to be added to the HTML's `<main>` 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.
|
||||
|
||||
#### Output formats
|
||||
|
||||
Each hook file can be overridden of a specific [output format](https://gohugo.io/templates/output-formats/). Eg. if you define a new output format `PLAINTEXT` in your `hugo.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.
|
||||
@@ -0,0 +1,5 @@
|
||||
+++
|
||||
title = "Arrrchetypes"
|
||||
weight = 3
|
||||
+++
|
||||
{{< piratify >}}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 124 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 84 KiB |
@@ -0,0 +1,87 @@
|
||||
+++
|
||||
title = "Frontmatter"
|
||||
weight = 2
|
||||
+++
|
||||
|
||||
Each Hugo page **has to define** a [frontmatter](https://gohugo.io/content/front-matter/).
|
||||
|
||||
## All Frontmatter Options
|
||||
|
||||
The values reflect example options. The defaults can be taken from the [annotated example](#annotated-frontmatter-options) below.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
{{% include "cont/frontmatter/frontmatter.toml" %}}
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Annotated Frontmatter Options
|
||||
|
||||
````toml {title="toml"}
|
||||
+++
|
||||
{{% include "cont/frontmatter/frontmatter.toml" %}}+++
|
||||
````
|
||||
|
||||
## 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.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
title = "GitHub repo"
|
||||
menuPre = "<i class='fab fa-github'></i> "
|
||||
{{< /multiconfig >}}
|
||||
|
||||
|
||||
|
||||
### Ordering Sibling Menu/Page Entries
|
||||
|
||||
Hugo provides a [flexible way](https://gohugo.io/content/ordering/) to handle order for your pages.
|
||||
|
||||
The simplest way is to set `weight` parameter to a number.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
title = "My page"
|
||||
weight = 5
|
||||
{{< /multiconfig >}}
|
||||
|
||||
### Using a Custom Title for Menu Entries
|
||||
|
||||
By default, the Relearn theme will use a page's `title` attribute for the menu item.
|
||||
|
||||
But a page's title has to be descriptive on its own while the menu is a hierarchy. Hugo adds the `linkTitle` parameter for that purpose:
|
||||
|
||||
For example (for a page named `content/install/linux.md`):
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
title = "Install on Linux"
|
||||
linkTitle = "Linux"
|
||||
{{< /multiconfig >}}
|
||||
|
||||
### 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](shortcodes/children) 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
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
collapsibleMenu = true
|
||||
[_build]
|
||||
render = "never"
|
||||
{{< /multiconfig >}}
|
||||
@@ -0,0 +1,5 @@
|
||||
+++
|
||||
title = "Frrrontmatter"
|
||||
weight = 2
|
||||
+++
|
||||
{{< piratify >}}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 3.1 KiB |
@@ -0,0 +1,262 @@
|
||||
# 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 hugo.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 hugo.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 hugo.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
|
||||
|
||||
# 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 value can contain the macro
|
||||
# `${FilePath}` which will be replaced by the file path of your displayed page.
|
||||
# If not set, the set value of your site's hugo.toml is used. If the global
|
||||
# parameter is given but you want to hide the button for the displayed page,
|
||||
# you can set the value to an empty string. If instead of hiding you want to have
|
||||
# an disabled button, you can set the value to a string containing just spaces.
|
||||
# This is useful if you want to give the opportunity for people to create merge
|
||||
# request for your content.
|
||||
editURL = ""
|
||||
|
||||
#++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||
# Menu
|
||||
# These options modify the menu apperance.
|
||||
|
||||
# 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.
|
||||
# If not set, the set value of your site's hugo.toml is used.
|
||||
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 hugo.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 hugo.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.lazy = 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 hugo.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 hugo.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 hugo.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 hugo.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 hugo.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 hugo.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 hugo.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 hugo.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 hugo.toml is used.
|
||||
customOpenapiURL = "" # "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"
|
||||
@@ -0,0 +1,101 @@
|
||||
+++
|
||||
title = "Multilingual and i18n"
|
||||
weight = 7
|
||||
+++
|
||||
|
||||
The Relearn theme is fully compatible with Hugo multilingual mode.
|
||||
|
||||
- Available languages: Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese. Feel free to contribute!
|
||||
- Full support for languages written right to left
|
||||
- Automatic menu generation from multilingual content
|
||||
- In-browser language switching
|
||||
|
||||
|
||||
|
||||
## Basic configuration
|
||||
|
||||
After learning [how Hugo handle multilingual websites](https://gohugo.io/content-management/multilingual), define your languages in your `hugo.toml` file.
|
||||
|
||||
For example with current English and Piratized English website.
|
||||
|
||||
{{% notice note %}}
|
||||
Make sure your default language is defined as the first one in the `[languages]` array, as the theme needs to make assumptions on it
|
||||
{{% /notice %}}
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
defaultContentLanguage = "en"
|
||||
|
||||
[languages]
|
||||
[languages.en]
|
||||
title = "Hugo Relearn Theme"
|
||||
weight = 1
|
||||
languageName = "English"
|
||||
|
||||
[languages.pir]
|
||||
title = "Cap'n Hugo Relearrrn Theme"
|
||||
weight = 2
|
||||
languageName = "Arrr! Pirrrates"
|
||||
{{< /multiconfig >}}
|
||||
|
||||
Then, for each new page, append the _id_ of the language to the file.
|
||||
|
||||
- Single file `my-page.md` is split in two files:
|
||||
- in English: `my-page.md`
|
||||
- in Piratized English: `my-page.pir.md`
|
||||
- Single file `_index.md` is split in two files:
|
||||
- in English: `_index.md`
|
||||
- in Piratized English: `_index.pir.md`
|
||||
|
||||
{{% notice info %}}
|
||||
Be aware that only translated pages are displayed in menu. It's not replaced with default language content.
|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice tip %}}
|
||||
Use [slug](https://gohugo.io/content-management/multilingual/#translate-your-content) frontmatter parameter to translate urls too.
|
||||
{{% /notice %}}
|
||||
|
||||
## Search
|
||||
|
||||
In case each page's content is written in one single language only, the above configuration will already configure the site's search functionality correctly.
|
||||
|
||||
{{% notice warning %}}
|
||||
Although the theme supports a wide variety of supported languages, the site's search via the [Lunr](https://lunrjs.com) search library does not.
|
||||
You'll see error reports in your browsers console log for each unsupported language. Currently unsupported are:
|
||||
|
||||
- Czech
|
||||
- Indonesian
|
||||
- Polish
|
||||
- Swahili
|
||||
{{% /notice %}}
|
||||
|
||||
### Search with mixed language support
|
||||
|
||||
In case your page's content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your `hugo.toml` to broaden search.
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
additionalContentLanguage = [ "en" ]
|
||||
{{< /multiconfig >}}
|
||||
|
||||
As this is an array, you can add multiple additional languages.
|
||||
|
||||
{{% notice note %}}
|
||||
Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in `zh-CN`, you have to add just `zh` to this parameter.
|
||||
{{% /notice %}}
|
||||
|
||||
## Overwrite translation strings
|
||||
|
||||
Translations strings are used for common default values used in the theme (_Edit_ button, _Search placeholder_ and so on). Translations are available in English and Piratized English but you may use another language or want to override default values.
|
||||
|
||||
To override these values, create a new file in your local i18n folder `i18n/<idlanguage>.toml` and inspire yourself from the theme `themes/hugo-theme-relearn/i18n/en.toml`
|
||||
|
||||
## Disable language switching
|
||||
|
||||
Switching the language in the browser is a great feature, but for some reasons you may want to disable it.
|
||||
|
||||
Just set `disableLanguageSwitchingButton=true` in your `hugo.toml`
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
disableLanguageSwitchingButton = true
|
||||
{{< /multiconfig >}}
|
||||
@@ -0,0 +1,5 @@
|
||||
+++
|
||||
title = "Multilingual an' i18n"
|
||||
weight = 7
|
||||
+++
|
||||
{{< piratify >}}
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
@@ -0,0 +1,68 @@
|
||||
+++
|
||||
title = "Image Effects"
|
||||
weight = 5
|
||||
+++
|
||||
|
||||
The theme supports non-standard [image effects](cont/markdown#image-effects).
|
||||
|
||||
| Name | Description |
|
||||
| -------- | ----------------------------------------------------------------- |
|
||||
| border | Draws a light thin border around the image |
|
||||
| lazy | Lets the image be lazy loaded |
|
||||
| lightbox | The image will be clickable to show it enlarged |
|
||||
| shadow | Draws a shadow around the image to make it appear hovered/glowing |
|
||||
|
||||
As [described](cont/markdown#image-effects), you can add this to the URL query parameter, but this may be cumbersome to be done consistently for the whole page.
|
||||
|
||||
Instead, you can configure the defaults in your `hugo.toml` aswell as overriding these default in the pages frontmatter.
|
||||
|
||||
Explicitly set URL query parameter will override the defaults in effect for a page.
|
||||
|
||||
Without any settings in your `hugo.toml` this defaults to
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[params]
|
||||
[params.imageEffects]
|
||||
border = false
|
||||
lazy = true
|
||||
lightbox = true
|
||||
shadow = false
|
||||
{{< /multiconfig >}}
|
||||
|
||||
This can be overridden in a pages frontmatter by eg.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
[imageEffects]
|
||||
border = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
Or by explicitly override settings by URL query parameter
|
||||
|
||||
````md {title="URL"}
|
||||
|
||||
````
|
||||
|
||||
The settings applied to the above image would be
|
||||
|
||||
{{< multiconfig >}}
|
||||
border = true
|
||||
lazy = true
|
||||
lightbox = false
|
||||
shadow = false
|
||||
bg-white = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
This ends up in the following HTML where the parameter are converted to CSS classes.
|
||||
|
||||
````html {title="HTML"}
|
||||
<img src="https://octodex.github.com/images/minion.png?lightbox=false&bg-white=true" loading="lazy" alt="Minion" class="bg-white border lazy nolightbox noshadow">
|
||||
````
|
||||
|
||||
|
||||
## 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 `hugo.toml` or pages frontmatter.
|
||||
|
||||
{{% notice note %}}
|
||||
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 `hugo.toml` or pages frontmatter.
|
||||
{{% /notice %}}
|
||||
@@ -0,0 +1,5 @@
|
||||
+++
|
||||
title = "Image Effects"
|
||||
weight = 5
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,690 @@
|
||||
+++
|
||||
tags = ["Content"]
|
||||
title = "Markdown syntax"
|
||||
weight = 4
|
||||
+++
|
||||
|
||||
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.
|
||||
|
||||
**Markdown** is a better way to write **HTML**, without all the complexities and ugliness that usually accompanies it.
|
||||
|
||||
Some of the key benefits are:
|
||||
|
||||
1. Markdown is simple to learn, with minimal extra characters so it's also quicker to write content.
|
||||
2. Less chance of errors when writing in Markdown.
|
||||
3. Produces valid HTML output.
|
||||
4. Keeps the content and the visual display separate, so you cannot mess up the look of your site.
|
||||
5. Write in any text editor or Markdown application you like.
|
||||
6. Markdown is a joy to use!
|
||||
|
||||
John Gruber, the author of Markdown, puts it like this:
|
||||
|
||||
> The 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.
|
||||
> <cite>John Gruber</cite>
|
||||
|
||||
Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:
|
||||
|
||||
{{% notice tip %}}
|
||||
{{% icon bookmark %}} Bookmark this page and the [official Commonmark reference](https://commonmark.org/help/) for easy future reference!
|
||||
{{% /notice %}}
|
||||
|
||||
## Paragraphs
|
||||
|
||||
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.
|
||||
|
||||
Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.
|
||||
|
||||
````md
|
||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||||
|
||||
Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||||
|
||||
Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
||||
{{% /notice %}}
|
||||
|
||||
## Headings
|
||||
|
||||
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.
|
||||
|
||||
In 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.
|
||||
|
||||
````md
|
||||
# h1 Heading
|
||||
|
||||
## h2 Heading
|
||||
|
||||
### h3 Heading
|
||||
|
||||
#### h4 Heading
|
||||
|
||||
##### h5 Heading
|
||||
|
||||
###### h6 Heading
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
# h1 Heading
|
||||
|
||||
## h2 Heading
|
||||
|
||||
### h3 Heading
|
||||
|
||||
#### h4 Heading
|
||||
|
||||
##### h5 Heading
|
||||
|
||||
###### h6 Heading
|
||||
{{% /notice %}}
|
||||
|
||||
## 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 `---`.
|
||||
|
||||
````md
|
||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||||
|
||||
---
|
||||
|
||||
Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
|
||||
|
||||
---
|
||||
|
||||
Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
|
||||
{{% /notice %}}
|
||||
|
||||
## Text Markers
|
||||
|
||||
### Bold
|
||||
|
||||
You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks `**`.
|
||||
|
||||
````md
|
||||
I am rendered with **bold text**
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
I am rendered with **bold text**
|
||||
{{% /notice %}}
|
||||
|
||||
### Italics
|
||||
|
||||
You can emphasize a snippet of text with italics by enclosing it with underscores `_`.
|
||||
|
||||
````md
|
||||
I am rendered with _italicized text_
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
I am rendered with _italicized text_
|
||||
{{% /notice %}}
|
||||
|
||||
### Strikethrough
|
||||
|
||||
In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes `~~`.
|
||||
|
||||
````md
|
||||
~~Strike through this text~~
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
~~Strike through this text~~
|
||||
{{% /notice %}}
|
||||
|
||||
## Text 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.
|
||||
|
||||
````md
|
||||
Double 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 `<<` or right `>>` are replaced by arrow **<<** and **>>** entities.
|
||||
|
||||
Three consecutive dots `...` are replaced by an ellipsis **...** entity.
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
Double 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 `<<` or right `>>` are replaced by arrow **<<** and **>>** entities.
|
||||
|
||||
Three consecutive dots `...` are replaced by an ellipsis **...** entity.
|
||||
{{% /notice %}}
|
||||
|
||||
## Lists
|
||||
|
||||
### Unordered
|
||||
|
||||
You can write a list of items in which the order of the items does not explicitly matter.
|
||||
|
||||
It is possible to nest lists by indenting an item for the next sublevel.
|
||||
|
||||
You may use any of `-`, `*` or `+` to denote bullets for each list item but should not switch between those symbols inside one whole list.
|
||||
|
||||
````md
|
||||
- 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
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="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
|
||||
{{% /notice %}}
|
||||
|
||||
### Ordered
|
||||
|
||||
You can create a list of items in which the order of items does explicitly matter.
|
||||
|
||||
It is possible to nest lists by indenting an item for the next sublevel.
|
||||
|
||||
Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.
|
||||
|
||||
````md
|
||||
1. 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
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
1. Lorem ipsum dolor sit amet
|
||||
1. 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
|
||||
{{% /notice %}}
|
||||
|
||||
### Tasks
|
||||
|
||||
In GFM (GitHub Flavored Markdown) you can add task lists resulting in checked or unchecked non-clickable items
|
||||
|
||||
````md
|
||||
- [x] Basic Test
|
||||
- [ ] More Tests
|
||||
- [x] View
|
||||
- [x] Hear
|
||||
- [ ] Smell
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
- [x] Basic Test
|
||||
- [ ] More Tests
|
||||
- [x] View
|
||||
- [x] Hear
|
||||
- [ ] Smell
|
||||
{{% /notice %}}
|
||||
|
||||
### 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.
|
||||
|
||||
A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.
|
||||
|
||||
If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible
|
||||
|
||||
````md
|
||||
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.
|
||||
: A telecommunication company.
|
||||
|
||||
You can't make juice out of it.
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="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.
|
||||
: A telecommunication company.
|
||||
|
||||
You can't make juice out of it.
|
||||
{{% /notice %}}
|
||||
|
||||
## Code
|
||||
|
||||
### Inline Code
|
||||
|
||||
Inline snippets of code can be wrapped with backticks `` ` ``.
|
||||
|
||||
````md
|
||||
In this example, `<div></div>` is marked as code.
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
In this example, `<div></div>` is marked as code.
|
||||
{{% /notice %}}
|
||||
|
||||
### Indented Code Block
|
||||
|
||||
A simple code block can be generated by indenting several lines of code by at least two spaces.
|
||||
|
||||
````md
|
||||
Be impressed by my advanced code:
|
||||
|
||||
// Some comments
|
||||
line 1 of code
|
||||
line 2 of code
|
||||
line 3 of code
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
Be impressed by my advanced code:
|
||||
|
||||
// Some comments
|
||||
line 1 of code
|
||||
line 2 of code
|
||||
line 3 of code
|
||||
{{% /notice %}}
|
||||
|
||||
### 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.
|
||||
|
||||
In 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.
|
||||
|
||||
See [Code Highlighting](shortcodes/highlight) for additional documentation.
|
||||
|
||||
````plaintext
|
||||
```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']
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
```
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
```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']
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
```
|
||||
{{% /notice %}}
|
||||
|
||||
## 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.
|
||||
|
||||
````md
|
||||
| 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. |
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="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. |
|
||||
{{% /notice %}}
|
||||
|
||||
### 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.
|
||||
|
||||
````md
|
||||
| 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. |
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="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. |
|
||||
{{% /notice %}}
|
||||
|
||||
## Blockquotes
|
||||
|
||||
For quoting blocks of content from another source within your document add `>` before any text you want to quote.
|
||||
|
||||
Blockquotes can also be nested.
|
||||
|
||||
````md
|
||||
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
||||
>
|
||||
> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
||||
>
|
||||
> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
> Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
|
||||
>
|
||||
> > Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
|
||||
>
|
||||
> Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
|
||||
{{% /notice %}}
|
||||
|
||||
## Links
|
||||
|
||||
### Autolink
|
||||
|
||||
In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.
|
||||
|
||||
````md
|
||||
This is a link to https://example.com.
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
This is a link to https://example.com.
|
||||
{{% /notice %}}
|
||||
|
||||
|
||||
### Basic Link
|
||||
|
||||
You can explicitly define links in case you want to use non-absolute URLs or want to give different text.
|
||||
|
||||
````md
|
||||
[Assemble](http://assemble.io)
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
[Assemble](http://assemble.io)
|
||||
{{% /notice %}}
|
||||
|
||||
### Link with Tooltip
|
||||
|
||||
For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.
|
||||
|
||||
````md
|
||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
[Upstage](https://github.com/upstage/ "Visit Upstage!")
|
||||
{{% /notice %}}
|
||||
|
||||
### Link 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.
|
||||
|
||||
````md
|
||||
[Example][somelinkID]
|
||||
|
||||
[somelinkID]: https://example.com "Go to example domain"
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
[Example][somelinkID]
|
||||
|
||||
[somelinkID]: https://example.com "Go to example domain"
|
||||
{{% /notice %}}
|
||||
|
||||
### Footnotes
|
||||
|
||||
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.
|
||||
|
||||
Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.
|
||||
|
||||
Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.
|
||||
|
||||
````md
|
||||
That'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.
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
That'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.
|
||||
{{% /notice %}}
|
||||
|
||||
## Images
|
||||
|
||||
### Basic Images
|
||||
|
||||
Images have a similar syntax to links but include a preceding exclamation mark.
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
### Image with Tooltip
|
||||
|
||||
Like links, images can also be given a tooltip.
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
### 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.
|
||||
|
||||
````md
|
||||
![La Forge][laforge]
|
||||
|
||||
[laforge]: https://octodex.github.com/images/trekkie.jpg "Geordi La Forge"
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
![La Forge][laforge]
|
||||
|
||||
[laforge]: https://octodex.github.com/images/trekkie.jpg?width=20vw "Geordi La Forge"
|
||||
{{% /notice %}}
|
||||
|
||||
### 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](cont/imageeffects) thru your `hugo.toml` or frontmatter parameter.
|
||||
|
||||
#### Resizing
|
||||
|
||||
Add query parameter `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
#### 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.
|
||||
|
||||
##### Shadow
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
##### Border
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
##### Left
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
##### Right
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
##### Inline
|
||||
|
||||
````md
|
||||
|
||||
|
||||
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
|
||||
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
##### Combination
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
#### Lightbox
|
||||
|
||||
Add the query parameter `lightbox=false` to the image link to disable the lightbox.
|
||||
|
||||
````md
|
||||
|
||||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
{{% notice 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:
|
||||
|
||||
````md
|
||||
[](https://octodex.github.com/#homercat)
|
||||
````
|
||||
|
||||
[](https://octodex.github.com/#homercat)
|
||||
|
||||
{{% /notice %}}
|
||||
@@ -0,0 +1,6 @@
|
||||
+++
|
||||
tags = ["Content"]
|
||||
title = "Marrrkdown rules"
|
||||
weight = 4
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,161 @@
|
||||
+++
|
||||
title = "Menu extra shortcuts"
|
||||
weight = 6
|
||||
+++
|
||||
|
||||
You can define additional menu entries or shortcuts in the navigation menu without any link to content.
|
||||
|
||||
## Basic configuration
|
||||
|
||||
Edit the website configuration `hugo.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.
|
||||
|
||||
Example from the current website:
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa-fw fab fa-github'></i> GitHub repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/McShelby/hugo-theme-relearn"
|
||||
weight = 10
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-camera'></i> Showcases"
|
||||
url = "showcase/"
|
||||
weight = 11
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-bookmark'></i> Hugo Documentation"
|
||||
identifier = "hugodoc"
|
||||
url = "https://gohugo.io/"
|
||||
weight = 20
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-bullhorn'></i> Credits"
|
||||
url = "more/credits/"
|
||||
weight = 30
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-tags'></i> Tags"
|
||||
url = "tags/"
|
||||
weight = 40
|
||||
{{< /multiconfig >}}
|
||||
|
||||
By default, shortcuts are preceded by a title. This title can be disabled by setting `disableShortcutsTitle=true`.
|
||||
However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.
|
||||
|
||||
For example, in your local `i18n/en.toml` file, add the following content
|
||||
|
||||
````toml {title="en.toml"}
|
||||
[Shortcuts-Title]
|
||||
other = "<Your value>"
|
||||
````
|
||||
|
||||
Read more about [hugo menu](https://gohugo.io/extras/menus/) and [hugo i18n translation strings](https://gohugo.io/content-management/multilingual/#translation-of-strings)
|
||||
|
||||
## Configuration for Multilingual mode {#i18n}
|
||||
|
||||
When using a multilingual website, you can set different menus for each language. In the `hugo.toml` file, prefix your menu configuration by `Languages.<language-id>`.
|
||||
|
||||
Example from the current website:
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[languages]
|
||||
[languages.en]
|
||||
title = "Hugo Relearn Theme"
|
||||
weight = 1
|
||||
languageName = "English"
|
||||
[languages.en.params]
|
||||
landingPageName = "<i class='fa-fw fas fa-home'></i> Home"
|
||||
|
||||
[[languages.en.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fab fa-github'></i> GitHub repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/McShelby/hugo-theme-relearn"
|
||||
weight = 10
|
||||
|
||||
[[languages.en.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-camera'></i> Showcases"
|
||||
pageRef = "showcase/"
|
||||
weight = 11
|
||||
|
||||
[[languages.en.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-bookmark'></i> Hugo Documentation"
|
||||
identifier = "hugodoc"
|
||||
url = "https://gohugo.io/"
|
||||
weight = 20
|
||||
|
||||
[[languages.en.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-bullhorn'></i> Credits"
|
||||
pageRef = "more/credits/"
|
||||
weight = 30
|
||||
|
||||
[[languages.en.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-tags'></i> Tags"
|
||||
pageRef = "tags/"
|
||||
weight = 40
|
||||
|
||||
[languages.pir]
|
||||
title = "Cap'n Hugo Relearrrn Theme"
|
||||
weight = 1
|
||||
languageName = "Arrr! Pirrrates"
|
||||
[languages.pir.params]
|
||||
landingPageName = "<i class='fa-fw fas fa-home'></i> Arrr! Home"
|
||||
|
||||
[[languages.pir.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fab fa-github'></i> GitHub repo"
|
||||
identifier = "ds"
|
||||
url = "https://github.com/McShelby/hugo-theme-relearn"
|
||||
weight = 10
|
||||
|
||||
[[languages.pir.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-camera'></i> Showcases"
|
||||
pageRef = "showcase/"
|
||||
weight = 11
|
||||
|
||||
[[languages.pir.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-bookmark'></i> Cap'n Hugo Documentat'n"
|
||||
identifier = "hugodoc"
|
||||
url = "https://gohugo.io/"
|
||||
weight = 20
|
||||
|
||||
[[languages.pir.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-bullhorn'></i> Crrredits"
|
||||
pageRef = "more/credits/"
|
||||
weight = 30
|
||||
|
||||
[[languages.pir.menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-tags'></i> Arrr! Tags"
|
||||
pageRef = "tags/"
|
||||
weight = 40
|
||||
{{< /multiconfig >}}
|
||||
|
||||
Read more about [hugo menu](https://gohugo.io/extras/menus/) and [hugo multilingual menus](https://gohugo.io/content-management/multilingual/#menus)
|
||||
|
||||
## Shortcuts to pages inside of your project
|
||||
|
||||
If you have shortcuts to pages inside of your project and you don't want them to show up in page menu section, you have two choices:
|
||||
|
||||
1. Make the page file for the shortcut a [headless branch bundle](https://gohugo.io/content-management/page-bundles/#headless-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.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
title = "Showcase"
|
||||
[_build]
|
||||
render = "always"
|
||||
list = "never"
|
||||
publishResources = true
|
||||
{{< /multiconfig >}}
|
||||
|
||||
2. Store the page file for the shortcut below a parent headless branch bundle and add the following frontmatter to he **parent** (see exampleSite's `content/more/_index.en.md`). **Don't give this page a `title`** as this will cause it to be shown in the breadcrumbs - a thing you most likely don't want.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
[_build]
|
||||
render = "never"
|
||||
list = "never"
|
||||
publishResources = false
|
||||
{{< /multiconfig >}}
|
||||
|
||||
In 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.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
title = "Credits"
|
||||
{{< /multiconfig >}}
|
||||
@@ -0,0 +1,5 @@
|
||||
+++
|
||||
title = "Menu extrrra shorrrtcuts"
|
||||
weight = 6
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,52 @@
|
||||
+++
|
||||
title = "Pages organization"
|
||||
weight = 1
|
||||
+++
|
||||
|
||||
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](https://gohugo.io/content/organization/). Typically, you will have a _content_ folder with all your pages.
|
||||
|
||||
````plaintext
|
||||
content
|
||||
├── level-one
|
||||
│ ├── level-two
|
||||
│ │ ├── level-three
|
||||
│ │ │ ├── level-four
|
||||
│ │ │ │ ├── _index.md <-- /level-one/level-two/level-three/level-four
|
||||
│ │ │ │ ├── page-4-a.md <-- /level-one/level-two/level-three/level-four/page-4-a
|
||||
│ │ │ │ ├── page-4-b.md <-- /level-one/level-two/level-three/level-four/page-4-b
|
||||
│ │ │ │ └── page-4-c.md <-- /level-one/level-two/level-three/level-four/page-4-c
|
||||
│ │ │ ├── _index.md <-- /level-one/level-two/level-three
|
||||
│ │ │ ├── page-3-a.md <-- /level-one/level-two/level-three/page-3-a
|
||||
│ │ │ ├── page-3-b.md <-- /level-one/level-two/level-three/page-3-b
|
||||
│ │ │ └── page-3-c.md <-- /level-one/level-two/level-three/page-3-c
|
||||
│ │ ├── _index.md <-- /level-one/level-two
|
||||
│ │ ├── page-2-a.md <-- /level-one/level-two/page-2-a
|
||||
│ │ ├── page-2-b.md <-- /level-one/level-two/page-2-b
|
||||
│ │ └── page-2-c.md <-- /level-one/level-two/page-2-c
|
||||
│ ├── _index.md <-- /level-one
|
||||
│ ├── page-1-a.md <-- /level-one/page-1-a
|
||||
│ ├── page-1-b.md <-- /level-one/page-1-b
|
||||
│ └── page-1-c.md <-- /level-one/page-1-c
|
||||
├── _index.md <-- /
|
||||
└── page-top.md <-- /page-top
|
||||
````
|
||||
|
||||
{{% notice note %}}
|
||||
`_index.md` is required in each folder, it’s your “folder home page”
|
||||
{{% /notice %}}
|
||||
|
||||
## Create 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](https://gohugo.io/overview/quickstart/).
|
||||
|
||||
Hugo provides a `new` command to create a new website.
|
||||
|
||||
````shell
|
||||
hugo new site <new_project>
|
||||
````
|
||||
|
||||
The Relearn theme provides [archetypes](cont/archetypes) to help you create this kind of pages.
|
||||
@@ -0,0 +1,5 @@
|
||||
+++
|
||||
title = "planks orrrganizat'n"
|
||||
weight = 1
|
||||
+++
|
||||
{{< piratify >}}
|
||||
@@ -0,0 +1,63 @@
|
||||
+++
|
||||
categories = ["taxonomy", "content"]
|
||||
tags = "tutorial"
|
||||
title = "Taxonomy"
|
||||
weight = 8
|
||||
+++
|
||||
|
||||
The Relearn theme supports Hugo's default taxonomies _tag_ and _category_ out of the box.
|
||||
|
||||
## Configuration
|
||||
|
||||
Just add tags and/or categories to any page. They can be given as a single string or an array of strings.
|
||||
|
||||
{{< multiconfig fm=true >}}
|
||||
categories = ["taxonomy", "content"]
|
||||
tags = "tutorial"
|
||||
title = "Taxonomy"
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Behavior
|
||||
|
||||
The tags are displayed at the top of the page in alphabetical order.
|
||||
|
||||
The categories are displayed at the bottom of the page in alphabetical order in the default implementation of the theme but can be customized by providing your own `content-footer.html` partial.
|
||||
|
||||
Each item is a link to a taxonomy page displaying all the articles with the given term.
|
||||
|
||||
## List all the tags
|
||||
|
||||
In the `hugo.toml` file you can add a shortcut to display all the tags and categories
|
||||
|
||||
{{< multiconfig file=hugo >}}
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-tags'></i> Tags"
|
||||
url = "/tags"
|
||||
|
||||
[[menu.shortcuts]]
|
||||
name = "<i class='fa-fw fas fa-layer-group'></i> Categories"
|
||||
url = "/categories"
|
||||
{{< /multiconfig >}}
|
||||
|
||||
## Customization
|
||||
|
||||
If you define [custom taxonomies](https://gohugo.io/content-management/taxonomies/#configure-taxonomies) and want to display a list of them somewhere on your page (often in the `layouts/partials/content-footer.html`) you can call a partial that does the job for you:
|
||||
|
||||
````go
|
||||
{{ partial "term-list.html" (dict
|
||||
"page" .
|
||||
"taxonomy" "categories"
|
||||
"icon" "layer-group"
|
||||
) }}
|
||||
````
|
||||
|
||||
### Parameter
|
||||
|
||||
| Name | Default | Notes |
|
||||
|-----------------------|-----------------|-------------|
|
||||
| **page** | _<empty>_ | Mandatory reference to the page. |
|
||||
| **taxonomy** | _<empty>_ | The plural name of the taxonomy to display as used in your frontmatter. |
|
||||
| **class** | _<empty>_ | Additional CSS classes set on the outermost generated HTML element.<br><br>If set to `tags` you will get the visuals for displaying the _tags_ taxonomy, otherwise it will be a simple list of links as for the _categories_ taxonomy. |
|
||||
| **style** | `primary` | The style scheme used if **class** is `tags`.<br><br>- by severity: `info`, `note`, `tip`, `warning`<br>- by brand color: `primary`, `secondary`, `accent`<br>- by color: `blue`, `green`, `grey`, `orange`, `red`<br>- by special color: `default`, `transparent`, `code` |
|
||||
| **color** | see notes | The [CSS color value](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) to be used if **class** is `tags`. If not set, the chosen color depends on the **style**. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching color for the severity<br>- for all other styles: the corresponding color |
|
||||
| **icon** | _<empty>_ | An optional [Font Awesome icon name](shortcodes/icon#finding-an-icon) set to the left of the list. |
|
||||
@@ -0,0 +1,7 @@
|
||||
+++
|
||||
categories = ["taxonomy", "content"]
|
||||
tags = "tutorrrial"
|
||||
title = "Taxonomy"
|
||||
weight = 8
|
||||
+++
|
||||
{{< piratify >}}
|
||||
Reference in New Issue
Block a user