Skip to content

Commit

Permalink
Clarify the shortcode Ordinal method
Browse files Browse the repository at this point in the history
  • Loading branch information
jmooring authored Nov 23, 2024
1 parent b7716ed commit ebbd2e8
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions content/en/methods/shortcode/Ordinal.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ action:

The `Ordinal` method returns the zero-based ordinal of the shortcode in relation to its parent. If the parent is the page itself, the ordinal represents the position of this shortcode in the page content.

{{% note %}}
Hugo increments the ordinal with each shortcode call, regardless of the specific shortcode type. This means that the ordinal value is tracked sequentially across all shortcodes within a given page.
{{% /note %}}

This method is useful for, among other things, assigning unique element IDs when a shortcode is called two or more times from the same page. For example:

{{< code file=content/about.md lang=md >}}
Expand Down

0 comments on commit ebbd2e8

Please sign in to comment.