Properties
The property list shortcode creates a custom HTML description list that can be used to display properties or variables and general dependent information. The shortcode requires a data file in data/properties/
, e.g. data/properties/demo.yaml
.
Name | Description | default |
---|---|---|
name | name of the file from the data/properties/ directory |
undefined |
sort (optional) | field name to use for sorting | undefined |
order (optional) | sort order, only applied if sort is set |
asc |
{{< propertylist name=demo (sort=name) (order=[asc|desc]) >}}
The supported attributes can be taken from the following example:
|
|
-
Property to demonstrate sorting.Default: none
-
Dummy description of the prop1 string property.Default: none
-
Another description for the integer property called prop2.Default: 10
-
A
bool
property with a complex multiline description and embedded Markdown:- List item 1
- List item 2
More description how to use this property.
Default: false