mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2025-03-20 16:15:09 +00:00
docs: utilize global image effects configuration #623
This commit is contained in:
Sören Weber
parent
151c31e142
commit
85d71e997a
12 changed files with 27 additions and 24 deletions
exampleSite
|
|
@ -233,3 +233,6 @@ title = "Hugo Relearn Documentation"
|
|||
mermaidZoom = true
|
||||
[params.siteparam.test]
|
||||
text = "A **nested** parameter <b>with</b> formatting"
|
||||
[params.imageEffects]
|
||||
bg-white = true # extension, not supported by the theme
|
||||
border = true
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ A theme for [Hugo](https://gohugo.io/) designed for documentation.
|
|||
|
||||
[★ What's new in the latest release ★]({{% relref "basics/migration" %}})
|
||||
|
||||
|
||||
|
||||
|
||||
## Motivation
|
||||
|
||||
|
|
|
|||
|
|
@ -225,4 +225,4 @@ landingPageName = "<i class='fas fa-home'></i> Home"
|
|||
|
||||
The home button is going to look like this:
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ Discover what this Hugo theme is all about and the core concepts behind it.
|
|||
|
||||
renders as
|
||||
|
||||
|
||||
|
||||
|
||||
The Relearn theme provides archetypes to create skeletons for your website. Begin by creating your first chapter page with the following command
|
||||
|
||||
|
|
|
|||
|
|
@ -9,4 +9,4 @@ Thanks to the simplicity of Hugo, this page is as empty as this theme needs requ
|
|||
|
||||
Just download at least version {{% badge color="fuchsia" icon="fab fa-hackerrank" title=" " %}}0.95.0{{% /badge %}} of the [Hugo binary](https://gohugo.io/getting-started/installing/) for your OS (Windows, Linux, Mac).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The Relearn theme defines some few archetypes of pages but you are free to defin
|
|||
|
||||
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
|
||||
|
||||
|
|
@ -36,7 +36,7 @@ Lorem Ipsum.
|
|||
|
||||
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
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ Replace the `X` with a number. Because this number will be used to generate the
|
|||
|
||||
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
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ The Relearn theme is fully compatible with Hugo multilingual mode.
|
|||
- Automatic menu generation from multilingual content
|
||||
- In-browser language switching
|
||||
|
||||
|
||||
|
||||
|
||||
## Basic configuration
|
||||
|
||||
|
|
|
|||
|
|
@ -57,5 +57,5 @@ This ends up in the following HTML where the parameter are converted to CSS clas
|
|||
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.
|
||||
|
||||
{{% notice note %}}
|
||||
If no extended parameter like `bg-white` in the example is set on the URL, a `classes="nobg-white"` in the HTML will only be generated if a default value was set in the `config.toml` or pages frontmatter.
|
||||
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.
|
||||
{{% /notice %}}
|
||||
|
|
|
|||
|
|
@ -533,7 +533,7 @@ Images have a similar syntax to links but include a preceding exclamation mark.
|
|||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
### Image with Tooltip
|
||||
|
|
@ -577,7 +577,7 @@ Add query parameter `width` and/or `height` to the link image to resize the imag
|
|||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
````markdown
|
||||
|
|
@ -585,7 +585,7 @@ Add query parameter `width` and/or `height` to the link image to resize the imag
|
|||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
````markdown
|
||||
|
|
@ -593,7 +593,7 @@ Add query parameter `width` and/or `height` to the link image to resize the imag
|
|||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
#### CSS Classes
|
||||
|
|
@ -607,7 +607,7 @@ Add a query parameter `classes` to the link image to add CSS classes. Add some o
|
|||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
##### Border
|
||||
|
|
@ -617,7 +617,7 @@ Add a query parameter `classes` to the link image to add CSS classes. Add some o
|
|||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
|
||||
{{% /notice %}}
|
||||
|
||||
##### Left
|
||||
|
|
@ -650,7 +650,7 @@ Add a query parameter `classes` to the link image to add CSS classes. Add some o
|
|||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -675,5 +675,5 @@ Add the query parameter `lightbox=false` to the image link to disable the lightb
|
|||
````
|
||||
|
||||
{{% notice style="secondary" icon="eye" title="Result" %}}
|
||||
|
||||
|
||||
{{% /notice %}}
|
||||
|
|
|
|||
|
|
@ -101,7 +101,7 @@ menuPre = "<i class='fab fa-github'></i> "
|
|||
+++
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### Ordering sibling menu/page entries
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ The location is mandatory due to Hugo's theme site builder.
|
|||
|
||||
### Preview `images/screenshot.png`
|
||||
|
||||
|
||||
|
||||
|
||||
## Hero Image
|
||||
|
||||
|
|
@ -80,8 +80,8 @@ The location of `images/tn.png` is mandatory due to Hugo's theme site builder.
|
|||
|
||||
### Preview `images/hero.png`
|
||||
|
||||
|
||||
|
||||
|
||||
### Preview `images/tn.png`
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -8,12 +8,12 @@ title = "Showcase"
|
|||
|
||||
## [GoboLinux Wiki](https://wiki.gobolinux.org/) by NEONsys.org
|
||||
|
||||
|
||||
|
||||
|
||||
## [BITS](https://bits-training.de/training/) by Dr. Lutz Gollan
|
||||
|
||||
|
||||
|
||||
|
||||
## [Pamasol Electrics](https://pamasol.github.io/de/) by Pamasol
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue