Docs
Release
Use 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.
Ensure the release parameter is set in the site’s configuration. The following example uses the Hinode repository hosted on GitHub.
[docs]
release = "https://github.com/gethinode/hinode/releases/tag/"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" >}}Sized feature button
Configure the size of the feature button by setting button-size.
markdown
{{< release version="v0.14.1" button-size="xs" >}}
{{< release version="v0.14.1" button-size="sm" >}}
{{< release version="v0.14.1" button-size="md" >}}
{{< release version="v0.14.1" button-size="lg" >}}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]. |
|
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. | ||
| 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. | ||
| Flag to render the element inline with the text. | ||||
| link-type | select | button |
v1.0.0
Style of the link. Supported values: [button, link]. |
|
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]. |
|
v1.0.0
State of the feature. Supported values: [new, deprecated]. |
||||
| short | bool | Flag to indicate the release button should use short notation. | ||
| Flag to indicate the release button should use short notation. | ||||
| size | select |
v1.0.0
Use button-size instead. Size of the button. Supported values: [sm, md, lg]. |
||
v1.0.0
Use button-size instead. Size of the button. Supported values: [sm, md, lg]. |
||||
| state | select |
v1.0.0
Use release-state instead. State of the feature. Supported values: [new, deprecated]. |
||
v1.0.0
Use release-state instead. State of the feature. Supported values: [new, deprecated]. |
||||
| type | select |
v1.0.0
Use link-type instead. Type of the element. Supported values: [link, 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. |
|
Version string, expects semver notation with a v prefix. |
||||