From 0568a3d03c6cb36c2e6686e7ddb97ac5a0888fb6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Wed, 18 Oct 2023 23:22:49 +0200 Subject: [PATCH] docs: add missing positional information for highlight shortcode --- exampleSite/content/shortcodes/highlight.en.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/exampleSite/content/shortcodes/highlight.en.md b/exampleSite/content/shortcodes/highlight.en.md index f1d41f7dad..4d0b704951 100644 --- a/exampleSite/content/shortcodes/highlight.en.md +++ b/exampleSite/content/shortcodes/highlight.en.md @@ -77,14 +77,14 @@ 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. | -| **title** | _<empty>_ | **Extension**. Arbitrary title for code. This displays the code like a [single tab]({{% relref "shortcodes/tab" %}}) if `hl_inline=false` (which is Hugos default). | -| **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. | -| _**<option>**_ | _<empty>_ | Any of [Hugo's supported options](https://gohugo.io/functions/highlight/#options). | -| _**<content>**_ | _<empty>_ | Your code to highlight. | +| Name | Position | Default | Notes | +|-----------------------|--------- | -----------------|-------------| +| **type** | 1 | _<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. | +| **title** | | _<empty>_ | **Extension**. Arbitrary title for code. This displays the code like a [single tab]({{% relref "shortcodes/tab" %}}) if `hl_inline=false` (which is Hugos default). | +| **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** | 2 | _<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. | +| _**<option>**_ | | _<empty>_ | Any of [Hugo's supported options](https://gohugo.io/functions/highlight/#options). | +| _**<content>**_ | | _<empty>_ | Your code to highlight. | ## Configuration