Docs
Release
Posted on December 30, 2023 (Last modified on June 20, 2025) • 3 min read • 466 wordsUse the release shortcode to indicate the availability of a specific feature in a tagged release.
Overview
Since Hinode v0.14.1 you can indicate the availability of a specific feature. The release shortcode renders a button that links to the specific release. Use the state to indicate if the feature is new or deprecated.
Arguments
The shortcode supports the following arguments:
| Name | Type | Required | Default | Comment |
|---|---|---|---|---|
| button-size | select | md |
v1.0.0
Size of the button. Supported values: [xs, sm, md, lg]. |
|
| class | string | Class attributes of the element. It supports Bootstrap attributes to modify the styling of the element. | ||
| inline | bool | Flag to render the element inline with the text. | ||
| link-type | select | button |
v1.0.0
Style of the link. Supported values: [button, link]. |
|
| release-state | select | new |
v1.0.0
State of the feature. Supported values: [new, deprecated]. |
|
| short | bool | Flag to indicate the release button should use short notation. | ||
| size | select | md |
v1.0.0
Use button-size instead. Size of the button. Supported values: [sm, md, lg]. |
|
| state | select | new |
v1.0.0
Use release-state instead. State of the feature. Supported values: [new, deprecated]. |
|
| type | select | button |
v1.0.0
Use link-type instead. Type of the element. Supported values: [link, button]. |
|
| version | string | yes | Version string, expects semver notation with a v prefix. |
| Name | Type | Required | Default |
|---|---|---|---|
| button-size | select | md |
|
v1.0.0
Size of the button. Supported values: [xs, sm, md, lg]. |
|||
| class | string | ||
| Class attributes of the element. It supports Bootstrap attributes to modify the styling of the element. | |||
| inline | bool | ||
| Flag to render the element inline with the text. | |||
| link-type | select | button |
|
v1.0.0
Style of the link. Supported values: [button, link]. |
|||
| release-state | select | new |
|
v1.0.0
State of the feature. Supported values: [new, deprecated]. |
|||
| short | bool | ||
| Flag to indicate the release button should use short notation. | |||
| size | select | md |
|
v1.0.0
Use button-size instead. Size of the button. Supported values: [sm, md, lg]. |
|||
| state | select | new |
|
v1.0.0
Use release-state instead. State of the feature. Supported values: [new, deprecated]. |
|||
| type | select | button |
|
v1.0.0
Use link-type instead. Type of the element. Supported values: [link, button]. |
|||
| version | string | yes | |
Version string, expects semver notation with a v prefix. |
|||
Site Configuration
Ensure the release parameter is set in the
Site’s Configuration.
Examples
Change the style of your release button using the available arguments.
New Feature
Indicate a new feature by using default values for the optional arguments.
Deprecated Feature
Indicate a deprecated feature by setting state to deprecated.
Short Feature
Shorten the button title by setting short to true.
markdown
{{< release version="v0.14.1" short="true" >}}
{{< release version="v0.14.1" short="true" release-state="deprecated" >}}