Release

Share via

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.

markdown
{{< release version="v0.14.1" >}}

Arguments

The shortcode supports the following arguments:

ArgumentRequiredDescription
versionYesRequired version string, expects semver notation with a “v” prefix.
stateNoOptional state, either “new” (default) or “deprecated”.
shortNoOptional flag to indicate the release button should use short notation.

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.

markdown
{{< release version="v0.14.1" >}}

Deprecated feature

Indicate a deprecated feature by setting state to deprecated.

markdown
{{< release version="v0.14.1" state="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" state="deprecated" >}}