Release
Use the release shortcode to indicate the availability of a specific feature in a tagged release.
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.
The shortcode supports the following arguments:
| Name | Type | Required | Default | Comment |
|---|---|---|---|---|
| class | string | Class attribute of the button element. | ||
| inline | bool | false | Flag to render the release button inline. | |
| short | bool | Flag to indicate the release button should use short notation. | ||
| size | select | md | Size of the button. Supported values: [sm, md, lg]. | |
| state | select | new | State of the feature. Supported values: [new, deprecated]. | |
| type | select | button | Type of the element. Supported values: [link, button]. | |
| version | string | yes | Version string, expects semver notation with a v prefix. |
Ensure the release parameter is set in the
site’s configuration.
Change the style of your release button using the available arguments.
Indicate a new feature by using default values for the optional arguments.
Indicate a deprecated feature by setting state to deprecated.
Shorten the button title by setting short to true.
{{< release version="v0.14.1" short="true" >}}
{{< release version="v0.14.1" short="true" state="deprecated" >}}