diff --git a/exampleSite/content/basics/migration/_index.en.md b/exampleSite/content/basics/migration/_index.en.md index 73ad5027b1..19c9417db0 100644 --- a/exampleSite/content/basics/migration/_index.en.md +++ b/exampleSite/content/basics/migration/_index.en.md @@ -265,7 +265,7 @@ This document shows you what's new in the latest release. For a detailed list of If 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. | Old | New | - | ------------------------------------------------------ | --------------------------------------------------------------- | + |--------------------------------------------------------|-----------------------------------------------------------------| | `` | `` | --- @@ -464,7 +464,7 @@ This document shows you what's new in the latest release. For a detailed list of In 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: | Type | 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` | diff --git a/exampleSite/content/cont/archetypes/_index.en.md b/exampleSite/content/cont/archetypes/_index.en.md index 035f6f3009..2e8cbd72e8 100644 --- a/exampleSite/content/cont/archetypes/_index.en.md +++ b/exampleSite/content/cont/archetypes/_index.en.md @@ -120,7 +120,7 @@ Related to each archetype, several _hook_ partial files in the form of `.h The following hooks are used: | Name | Notes | -|:---------------------|:------------| +|----------------------|-------------| | styleclass | Defines a set of CSS classes to be added to the HTML's `
` 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 | diff --git a/exampleSite/content/cont/markdown.en.md b/exampleSite/content/cont/markdown.en.md index 07d2694cd1..dee0c5e4cc 100644 --- a/exampleSite/content/cont/markdown.en.md +++ b/exampleSite/content/cont/markdown.en.md @@ -377,7 +377,7 @@ In GFM (GitHub Flavored Markdown) you can create tables by adding pipes as divid ````markdown | 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. | @@ -385,7 +385,7 @@ In GFM (GitHub Flavored Markdown) you can create tables by adding pipes as divid {{% 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. | @@ -397,7 +397,7 @@ Adding a colon on the left and/or right side of the dashes below any heading wil ````markdown | 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. | @@ -405,7 +405,7 @@ Adding a colon on the left and/or right side of the dashes below any heading wil {{% 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. | diff --git a/exampleSite/content/shortcodes/attachments/index.en.md b/exampleSite/content/shortcodes/attachments/index.en.md index 3019546af3..7f8ecaba5b 100644 --- a/exampleSite/content/shortcodes/attachments/index.en.md +++ b/exampleSite/content/shortcodes/attachments/index.en.md @@ -38,7 +38,7 @@ While the examples are using shortcodes with named parameter you are free to als ### Parameter | Name | Default | Notes | -|:------------|:----------------|:------------| +|-------------|-----------------|-------------| | **style** | `transparent` | The style scheme used for the box.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`, `accent`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- 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 not set, the chosen color depends on the **style**. Any given value will overwrite the default.

- for severity styles: a nice matching color for the severity
- for all other styles: the corresponding color | | **title** | see notes | Arbitrary text for the box title. Depending on the **style** there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other styles: `Attachments`

If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | diff --git a/exampleSite/content/shortcodes/badge.en.md b/exampleSite/content/shortcodes/badge.en.md index 7d2a546351..d49b098dcc 100644 --- a/exampleSite/content/shortcodes/badge.en.md +++ b/exampleSite/content/shortcodes/badge.en.md @@ -65,7 +65,7 @@ While the examples are using shortcodes with named parameter you are free to als ### Parameter | Name | Default | Notes | -|:----------------------|:----------------|:------------| +|-----------------------|-----------------|-------------| | **style** | `default` | The style scheme used for the badge.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`, `accent`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- 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 not set, the chosen color depends on the **style**. Any given value will overwrite the default.

- for severity styles: a nice matching color for the severity
- for all other styles: the corresponding color | | **title** | see notes | Arbitrary text for the badge title. Depending on the **style** there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other styles: _<empty>_

If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | diff --git a/exampleSite/content/shortcodes/button.en.md b/exampleSite/content/shortcodes/button.en.md index f07c4b8e9c..5d95b83231 100644 --- a/exampleSite/content/shortcodes/button.en.md +++ b/exampleSite/content/shortcodes/button.en.md @@ -46,7 +46,7 @@ Once the button is clicked, it opens another browser tab for the given URL. ### Parameter | Name | Default | Notes | -|:----------------------|:----------------|:------------| +|-----------------------|-----------------|-------------| | **href** | _<empty>_ | Either the destination URL for the button or JavaScript code to be executed on click. If this parameter is not set, the button will do nothing but is still displayed as clickable.

- if starting with `javascript:` all following text will be executed in your browser
- every other string will be interpreted as URL| | **style** | `transparent` | The style scheme used for the button.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`, `accent`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- 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 not set, the chosen color depends on the **style**. Any given value will overwrite the default.

- for severity styles: a nice matching color for the severity
- for all other styles: the corresponding color | diff --git a/exampleSite/content/shortcodes/children/_index.en.md b/exampleSite/content/shortcodes/children/_index.en.md index ba7fd58015..4397a3d68d 100644 --- a/exampleSite/content/shortcodes/children/_index.en.md +++ b/exampleSite/content/shortcodes/children/_index.en.md @@ -35,7 +35,7 @@ While the examples are using shortcodes with named parameter you are free to als ### Parameter | Name | Default | Notes | -|:-------------------|:------------------|:------------| +|--------------------|-------------------|-------------| | **containerstyle** | `ul` | Choose the style used to group all children. It could be any HTML tag name. | | **style** | `li` | Choose the style used to display each descendant. It could be any HTML tag name. | | **showhidden** | `false` | When `true`, child pages hidden from the menu will be displayed as well. | diff --git a/exampleSite/content/shortcodes/expand.en.md b/exampleSite/content/shortcodes/expand.en.md index e2f9a198db..9e0ead6e09 100644 --- a/exampleSite/content/shortcodes/expand.en.md +++ b/exampleSite/content/shortcodes/expand.en.md @@ -58,7 +58,7 @@ While the examples are using shortcodes with named parameter you are free to use ### Parameter | Name | Position | Default | Notes | -|:----------------------|:---------|:-----------------|:------------| +|-----------------------|----------|------------------|-------------| | **title** | 1 | `"Expand me..."` | Arbitrary text to appear next to the expand/collapse icon. | | **open** | 2 | `false` | When `true` the content text will be initially shown as expanded. | | _**<content>**_ | | _<empty>_ | Arbitrary text to be displayed on expand. | diff --git a/exampleSite/content/shortcodes/highlight.en.md b/exampleSite/content/shortcodes/highlight.en.md index 13717c80ec..ed4e857185 100644 --- a/exampleSite/content/shortcodes/highlight.en.md +++ b/exampleSite/content/shortcodes/highlight.en.md @@ -80,7 +80,7 @@ print("Hello World!") ### Parameter | Name | Default | Notes | -|:----------------------|:-----------------|:------------| +|-----------------------|------------------|-------------| | **type** | _<empty>_ | The language of the code to highlight. Choose from one of the [supported languages](https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages). Case-insensitive. | | **wrap** | see notes | _Extension_. When `true` the content may wrap on long lines otherwise it will be scrollable.

The default value can be set in your `config.toml` and overwritten via frontmatter. [See below](#configuration). | | **options** | _<empty>_ | An optional, comma-separated list of zero or more [Hugo supported options](https://gohugo.io/functions/highlight/#options) as well as extension parameter from this table. | diff --git a/exampleSite/content/shortcodes/icon.en.md b/exampleSite/content/shortcodes/icon.en.md index 558129f1af..74b093f8a4 100644 --- a/exampleSite/content/shortcodes/icon.en.md +++ b/exampleSite/content/shortcodes/icon.en.md @@ -56,7 +56,7 @@ While the examples are using shortcodes with positional parameter you are free t ### Parameter | Name | Position | Default | Notes | -|:----------------------|:---------|:----------------|:------------| +|-----------------------|----------|-----------------|-------------| | **icon** | 1 | _<empty>_ | [Font Awesome icon name]({{%relref "#finding-an-icon" %}}) to be displayed. It will be displayed in the text color of its according context. | ### Finding an icon diff --git a/exampleSite/content/shortcodes/include.en.md b/exampleSite/content/shortcodes/include.en.md index 1fa9a2e9e4..95bc43555e 100644 --- a/exampleSite/content/shortcodes/include.en.md +++ b/exampleSite/content/shortcodes/include.en.md @@ -41,7 +41,7 @@ The included files can even contain Markdown and will be taken into account when ### Parameter | Name | Position | Default | Notes | -|:---------------------|:---------|:-----------------|:------------| +|----------------------|----------|------------------|-------------| | **file** | 1 | _<empty>_ | The path to the file to be included. Path resolution adheres to [Hugo's build-in `readFile` function](https://gohugo.io/functions/readfile/) | | **hidefirstheading** | 2 | `false` | When `true` and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files. | diff --git a/exampleSite/content/shortcodes/math.en.md b/exampleSite/content/shortcodes/math.en.md index b16bd1f63f..22b78b10db 100644 --- a/exampleSite/content/shortcodes/math.en.md +++ b/exampleSite/content/shortcodes/math.en.md @@ -59,7 +59,7 @@ $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \ ### Parameter | Name | Default | Notes | -|:----------------------|:-----------------|:------------| +|-----------------------|------------------|-------------| | **align** | `center` | Allowed values are `left`, `center` or `right`. | | _**<content>**_ | _<empty>_ | Your formuale. | diff --git a/exampleSite/content/shortcodes/mermaid.en.md b/exampleSite/content/shortcodes/mermaid.en.md index 2156b636bc..905d81ac01 100644 --- a/exampleSite/content/shortcodes/mermaid.en.md +++ b/exampleSite/content/shortcodes/mermaid.en.md @@ -72,7 +72,7 @@ The generated graphs can be be panned by dragging them and zoomed by using the m ### Parameter | Name | Default | Notes | -|:----------------------|:-----------------|:------------| +|-----------------------|------------------|-------------| | **align** | `center` | Allowed values are `left`, `center` or `right`. | | **zoom** | see notes | Whether the graph is pan- and zoomable.

If not set the value is determined by the `mermaidZoom` setting of the [site](#global-configuration-file) or the [pages frontmatter](#pages-frontmatter) or `false` if not set at all.

- `false`: no pan or zoom
- `true`: pan and zoom active | | _**<content>**_ | _<empty>_ | Your Mermaid graph. | diff --git a/exampleSite/content/shortcodes/notice.en.md b/exampleSite/content/shortcodes/notice.en.md index c91c1c0d67..50a022da35 100644 --- a/exampleSite/content/shortcodes/notice.en.md +++ b/exampleSite/content/shortcodes/notice.en.md @@ -50,7 +50,7 @@ It is all about the boxes. ### Parameter | Name | Position | Default | Notes | -|:----------|:---------|:----------|:------------| +|-----------|----------|-----------|-------------| | **style** | 1 | `default` | The style scheme used for the box.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`, `accent`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- 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 not set, the chosen color depends on the **style**. Any given value will overwrite the default.

- for severity styles: a nice matching color for the severity
- for all other styles: the corresponding color | | **title** | 2 | see notes | Arbitrary text for the box title. Depending on the **style** there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other styles: _<empty>_

If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | diff --git a/exampleSite/content/shortcodes/openapi/_index.en.md b/exampleSite/content/shortcodes/openapi/_index.en.md index 59a20a1736..db73bc22da 100644 --- a/exampleSite/content/shortcodes/openapi/_index.en.md +++ b/exampleSite/content/shortcodes/openapi/_index.en.md @@ -36,7 +36,7 @@ While the examples are using shortcodes with named parameter you are free to als ### Parameter | Name | Default | Notes | -|:---------------------|:-----------------|:------------| +|----------------------|------------------|-------------| | **src** | _<empty>_ | The URL to the OpenAPI specification file. This can be relative to the URL of your page if it is a leaf or branch bundle. | {{% notice note %}} diff --git a/exampleSite/content/shortcodes/siteparam.en.md b/exampleSite/content/shortcodes/siteparam.en.md index fc0e2d52f5..5a6462a7b1 100644 --- a/exampleSite/content/shortcodes/siteparam.en.md +++ b/exampleSite/content/shortcodes/siteparam.en.md @@ -40,7 +40,7 @@ While the examples are using shortcodes with named parameter you are free to use ### Parameter | Name | Position | Default | Notes | -|:---------------------|:---------|:-----------------|:------------| +|----------------------|----------|------------------|-------------| | **name** | 1 | _<empty>_ | The name of the site param to be displayed. | ## Examples diff --git a/exampleSite/content/shortcodes/tab.en.md b/exampleSite/content/shortcodes/tab.en.md index 99b79edd0e..c78742c5c9 100644 --- a/exampleSite/content/shortcodes/tab.en.md +++ b/exampleSite/content/shortcodes/tab.en.md @@ -49,7 +49,7 @@ printf("Hello World!"); ### Parameter | Name | Default | Notes | -|:----------------------|:----------------|:------------| +|-----------------------|-----------------|-------------| | **style** | see notes | The style scheme used for the tab. If you don't set a style and you display a single code block inside of the tab, its default styling will adapt to that of a `code` block. Otherwise `default` is used.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`, `accent`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- 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 not set, the chosen color depends on the **style**. Any given value will overwrite the default.

- for severity styles: a nice matching color for the severity
- for all other styles: the corresponding color | | **title** | see notes | Arbitrary title for the tab. Depending on the **style** there may be a default title. Any given value will overwrite the default.

- for severity styles: the matching title for the severity
- for all other styles: _<empty>_

If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) | diff --git a/exampleSite/content/shortcodes/tabs.en.md b/exampleSite/content/shortcodes/tabs.en.md index 8ae852b32c..0c1d12f5f9 100644 --- a/exampleSite/content/shortcodes/tabs.en.md +++ b/exampleSite/content/shortcodes/tabs.en.md @@ -92,7 +92,7 @@ printf"Hello World!"); ### Parameter | Name | Default | Notes | -|:----------------------|:---------------------|:------------| +|-----------------------|----------------------|-------------| | **groupid** | _<random>_ | Arbitrary name of the group the tab view belongs to.

Tab views with the same **groupid** sychronize their selected tab. The tab selection is restored automatically based on the `groupid` for tab view. If the selected tab can not be found in a tab group the first tab is selected instead.

This sychronization applies to the whole site! | | **style** | _<empty>_ | Sets a default value for every contained tab. Can be overridden by each tab. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values. | | **color** | _<empty>_ | Sets a default value for every contained tab. Can be overridden by each tab. See the [`tab` shortcode]({{% relref "shortcodes/tab#parameter" %}}) for possible values. |