nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 09:43:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix typos

Browse source
This commit is contained in:
Sören Weber 2023-01-14 01:39:28 +01:00
parent 0100506bec
commit fafc04cb42
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
8 changed files with 19 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
exampleSite/content/cont/syntaxhighlight.en.md
View file

@ -56,9 +56,9 @@ You can choose a color theme from the [list of supported themes](https://xyproto
````toml
[markup]
[markup.highlight]
# if set to `guessSyntax = true`, there will be no unstyled code even if no language
# was given BUT mermaid code fences will not work anymore! So this is a mandatory
# setting for your site
# if `guessSyntax = true`, there will be no unstyled code even if no language
# was given BUT Mermaid and Math codefences will not work anymore! So this is a
# mandatory setting for your site if you want to use Mermaid or Math codefences
guessSyntax = false
# choose a color theme or create your own

14
exampleSite/content/shortcodes/attachments.en.md
View file

@ -41,7 +41,7 @@ The shortcode lists files found in a specific folder. The name of the folder dep
> * attachment.pdf
> * page.md
2. If your page is a branch or leaf bundle, attachments must be placed in a nested `_index.files` or 'index.files' folder, accordingly.
2. If your page is a branch or leaf bundle, attachments must be placed in a nested `_index.files` or `index.files` folder, accordingly.
For branch bundles:
@ -79,21 +79,21 @@ Eg. for a site in English and Piratish:
| Name | Default | Notes |
|:------------|:--------------|:------------|
| **style** | `transparent` | The color scheme used to highlight the box content.<br><br>- by severity: `info`, `note`, `tip`, `warning`<nd color: `primary`, `secondary`<br>- by color: `blue`, `green`, `grey`, `orange`, `red`<br>- by special color: `default`,t` |
| **title** | see notes | Arbitrary text for the box title. Depending on the **style** there may be a default title. Any given value will overwault.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: `Attachments`<br><br>If you wa you have to set this parameter to `" "` (a non empty string filled with spaces) |
| **icon** | see notes | [Font Awesome icon name]({{%relref "shortcodes/icon#finding-an-icon" %}}) set to the left of the title. Depending le** there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching iseverity<br>- for all other colors: `paperclip`<br><br>If you want no icon, you have to set this parameter to `" "` (a non empty d with spaces) |
| **style** | `transparent` | The color scheme used to highlight the box content.<br><br>- by severity: `info`, `note`, `tip`, `warning`<br>- by brand color: `primary`, `secondary`<br>- by color: `blue`, `green`, `grey`, `orange`, `red`<br>- by special color: `default`, `transparent` |
| **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 colors: `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) |
| **icon** | see notes | [Font Awesome icon name]({{%relref "shortcodes/icon#finding-an-icon" %}}) set to the left of the title. Depending on the **style** there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other colors: `paperclip`<br><br>If you want no icon, you have to set this parameter to `" "` (a non empty d with spaces) |
| **sort** | `asc` | Sorting the output in `asc`ending or `desc`ending order. |
| **pattern** | `.*` | A [regular expressions](https://en.wikipedia.org/wiki/Regular_expression), used to filter the attachments by file name. For example:<br><br>- to match a file suffix of 'jpg', use `.*jpg` (not `*.jpg`)<br>- to match file names ending in `jpg` or `png`, use `.*(jpg\|png)` |
| **pattern** | `.*` | A [regular expressions](https://en.wikipedia.org/wiki/Regular_expression), used to filter the attachments by file name. For example:<br><br>- to match a file suffix of 'jpg', use `.*\.jpg` (not `*.\.jpg`)<br>- to match file names ending in `jpg` or `png`, use `.*\.(jpg\|png)` |
## Examples
### Custom Title, List of Attachments Ending in pdf or mp4
````go
{{%/* attachments title="Related files" pattern=".*(pdf|mp4)" /*/%}}
{{%/* attachments title="Related files" pattern=".*\.(pdf|mp4)" /*/%}}
````
{{% attachments title="Related files" pattern=".*(pdf|mp4)" /%}}
{{% attachments title="Related files" pattern=".*\.(pdf|mp4)" /%}}
### Info Styled Box, Descending Sort Order

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

@ -4,7 +4,7 @@ description = "List the child pages of a page"
title = "Children"
+++
The `children` shortcode lists the child pages of the current page and its descendants .
The `children` shortcode lists the child pages of the current page and its descendants.
{{% children sort="weight" %}}
## Usage

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

@ -125,7 +125,7 @@ $$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \
### Codefence
You can also use codefences but without further parameter.
You can also use codefences.
````md
```math

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

@ -235,7 +235,7 @@ A **orange** disclaimer
A **orange** disclaimer
{{% /notice %}}
#### Red
#### Red without a Title and Icon
````go
{{%/* notice style="red" */%}}

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

@ -3,7 +3,7 @@ description: "UI for your Swagger / OpenAPI Specifications"
title: "Swagger"
---
This shortcode uses the [RapiDoc](https://mrin9.github.io/RapiDoc) library to display your Swagger / OpenAPI Specifications.
The `swagger` shortcode uses the [RapiDoc](https://mrin9.github.io/RapiDoc) library to display your Swagger / OpenAPI Specifications.
{{% notice note %}}
This only works in modern browsers.

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

@ -1,9 +1,11 @@
+++
description = "Show content in tabbed views"
title = "Tabbed views"
title = "Tabs"
+++
The `tabs` shortcode displays arbitrary content in unlimited number of tabs. This comes in handy eg. for providing code snippets for multiple languages or providing configuration in different formats.
The `tabs` shortcode displays arbitrary content in unlimited number of tabs.
This comes in handy eg. for providing code snippets for multiple languages or providing configuration in different formats.
{{< tabs groupid="tabs-example-language" >}}
{{% tab name="python" %}}

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

@ -1,5 +1,5 @@
+++
descrption = "Synchr'nize select'n o' content 'n different tabbed views"
title = "Tabbed views"
title = "Tabs"
+++
{{< piratify >}}