diff --git a/exampleSite/content/cont/syntaxhighlight.en.md b/exampleSite/content/cont/syntaxhighlight.en.md index d4b23b24fb..d881e7f6af 100644 --- a/exampleSite/content/cont/syntaxhighlight.en.md +++ b/exampleSite/content/cont/syntaxhighlight.en.md @@ -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 diff --git a/exampleSite/content/shortcodes/attachments.en.md b/exampleSite/content/shortcodes/attachments.en.md index 44164ce90b..941f645541 100644 --- a/exampleSite/content/shortcodes/attachments.en.md +++ b/exampleSite/content/shortcodes/attachments.en.md @@ -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.

- by severity: `info`, `note`, `tip`, `warning`- by color: `blue`, `green`, `grey`, `orange`, `red`
- 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.

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

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.

- for severity styles: a nice matching iseverity
- for all other colors: `paperclip`

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.

- by severity: `info`, `note`, `tip`, `warning`
- by brand color: `primary`, `secondary`
- by color: `blue`, `green`, `grey`, `orange`, `red`
- 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.

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

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.

- for severity styles: a nice matching icon for the severity
- for all other colors: `paperclip`

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:

- to match a file suffix of 'jpg', use `.*jpg` (not `*.jpg`)
- 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:

- to match a file suffix of 'jpg', use `.*\.jpg` (not `*.\.jpg`)
- 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 diff --git a/exampleSite/content/shortcodes/children/_index.en.md b/exampleSite/content/shortcodes/children/_index.en.md index dc84fe39fa..d7b67da0a0 100644 --- a/exampleSite/content/shortcodes/children/_index.en.md +++ b/exampleSite/content/shortcodes/children/_index.en.md @@ -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 diff --git a/exampleSite/content/shortcodes/math.en.md b/exampleSite/content/shortcodes/math.en.md index c66a9ee9ae..8c1f7d52b4 100644 --- a/exampleSite/content/shortcodes/math.en.md +++ b/exampleSite/content/shortcodes/math.en.md @@ -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 diff --git a/exampleSite/content/shortcodes/notice.en.md b/exampleSite/content/shortcodes/notice.en.md index 7116d7f605..36e5106e52 100644 --- a/exampleSite/content/shortcodes/notice.en.md +++ b/exampleSite/content/shortcodes/notice.en.md @@ -235,7 +235,7 @@ A **orange** disclaimer A **orange** disclaimer {{% /notice %}} -#### Red +#### Red without a Title and Icon ````go {{%/* notice style="red" */%}} diff --git a/exampleSite/content/shortcodes/swagger/_index.en.md b/exampleSite/content/shortcodes/swagger/_index.en.md index 96f0ce3ad2..998e092ae5 100644 --- a/exampleSite/content/shortcodes/swagger/_index.en.md +++ b/exampleSite/content/shortcodes/swagger/_index.en.md @@ -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. diff --git a/exampleSite/content/shortcodes/tabs.en.md b/exampleSite/content/shortcodes/tabs.en.md index f41edb0b03..c897fa78bc 100644 --- a/exampleSite/content/shortcodes/tabs.en.md +++ b/exampleSite/content/shortcodes/tabs.en.md @@ -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" %}} diff --git a/exampleSite/content/shortcodes/tabs.pir.md b/exampleSite/content/shortcodes/tabs.pir.md index bfbe015e13..c7771f5a15 100644 --- a/exampleSite/content/shortcodes/tabs.pir.md +++ b/exampleSite/content/shortcodes/tabs.pir.md @@ -1,5 +1,5 @@ +++ descrption = "Synchr'nize select'n o' content 'n different tabbed views" -title = "Tabbed views" +title = "Tabs" +++ {{< piratify >}} \ No newline at end of file