nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-01-18 19:00:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: don't align table cells #596

Browse source 
to allow pirate translation to be RTL
This commit is contained in:
Sören Weber 2023-07-27 16:07:01 +02:00
parent 5e73439a41
commit 9b47e855b8
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
18 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
exampleSite/content/basics/migration/_index.en.md
View file

@ -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 |
| ------------------------------------------------------ | --------------------------------------------------------------- |
|--------------------------------------------------------|-----------------------------------------------------------------|
| `<img src="pic.png?width=20vw&classes=shadow,border">` | `<img src="pic.png" style="width:20vw;" class="shadow border">` |
---
@ -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` |

2
exampleSite/content/cont/archetypes/_index.en.md
View file

@ -120,7 +120,7 @@ Related to each archetype, several _hook_ partial files in the form of `<hook>.h
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 |

8
exampleSite/content/cont/markdown.en.md
View file

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

2
exampleSite/content/shortcodes/attachments/index.en.md
View file

@ -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.<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 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 |
| **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.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: `Attachments`<br><br>If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |

2
exampleSite/content/shortcodes/badge.en.md
View file

@ -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.<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 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 |
| **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.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: _&lt;empty&gt;_<br><br>If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |

2
exampleSite/content/shortcodes/button.en.md
View file

@ -46,7 +46,7 @@ Once the button is clicked, it opens another browser tab for the given URL.
### Parameter
| Name | Default | Notes |
|:----------------------|:----------------|:------------|
|-----------------------|-----------------|-------------|
| **href** | _&lt;empty&gt;_ | 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.<br><br>- if starting with `javascript:` all following text will be executed in your browser<br>- every other string will be interpreted as URL|
| **style** | `transparent` | The style scheme used for the button.<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 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 |

2
exampleSite/content/shortcodes/children/_index.en.md
View file

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

2
exampleSite/content/shortcodes/expand.en.md
View file

@ -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. |
| _**&lt;content&gt;**_ | | _&lt;empty&gt;_ | Arbitrary text to be displayed on expand. |

2
exampleSite/content/shortcodes/highlight.en.md
View file

@ -80,7 +80,7 @@ print("Hello World!")
### Parameter
| Name | Default | Notes |
|:----------------------|:-----------------|:------------|
|-----------------------|------------------|-------------|
| **type** | _&lt;empty&gt;_ | 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.<br><br>The default value can be set in your `config.toml` and overwritten via frontmatter. [See below](#configuration). |
| **options** | _&lt;empty&gt;_ | 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. |

2
exampleSite/content/shortcodes/icon.en.md
View file

@ -56,7 +56,7 @@ While the examples are using shortcodes with positional parameter you are free t
### Parameter
| Name | Position | Default | Notes |
|:----------------------|:---------|:----------------|:------------|
|-----------------------|----------|-----------------|-------------|
| **icon** | 1 | _&lt;empty&gt;_ | [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

2
exampleSite/content/shortcodes/include.en.md
View file

@ -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 | _&lt;empty&gt;_ | 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. |

2
exampleSite/content/shortcodes/math.en.md
View file

@ -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`. |
| _**&lt;content&gt;**_ | _&lt;empty&gt;_ | Your formuale. |

2
exampleSite/content/shortcodes/mermaid.en.md
View file

@ -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.<br><br>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.<br><br>- `false`: no pan or zoom<br>- `true`: pan and zoom active |
| _**&lt;content&gt;**_ | _&lt;empty&gt;_ | Your Mermaid graph. |

2
exampleSite/content/shortcodes/notice.en.md
View file

@ -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.<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 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 |
| **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.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: _&lt;empty&gt;_<br><br>If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |

2
exampleSite/content/shortcodes/openapi/_index.en.md
View file

@ -36,7 +36,7 @@ While the examples are using shortcodes with named parameter you are free to als
### Parameter
| Name | Default | Notes |
|:---------------------|:-----------------|:------------|
|----------------------|------------------|-------------|
| **src** | _&lt;empty&gt;_ | 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 %}}

2
exampleSite/content/shortcodes/siteparam.en.md
View file

@ -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 | _&lt;empty&gt;_ | The name of the site param to be displayed. |
## Examples

2
exampleSite/content/shortcodes/tab.en.md
View file

@ -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.<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 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 |
| **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.<br><br>- for severity styles: the matching title for the severity<br>- for all other styles: _&lt;empty&gt;_<br><br>If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |

2
exampleSite/content/shortcodes/tabs.en.md
View file

@ -92,7 +92,7 @@ printf"Hello World!");
### Parameter
| Name | Default | Notes |
|:----------------------|:---------------------|:------------|
|-----------------------|----------------------|-------------|
| **groupid** | _&lt;random&gt;_ | Arbitrary name of the group the tab view belongs to.<br><br>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.<br><br>This sychronization applies to the whole site! |
| **style** | _&lt;empty&gt;_ | 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** | _&lt;empty&gt;_ | 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. |