hugo-geekdoc/exampleSite/content/en/shortcodes/propertylist.md

---
title: 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`.

## Attributes

| 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`     |

## Usage

<!-- prettier-ignore-start -->
```tpl
{{</* propertylist name=demo (sort=name) (order=[asc|desc]) */>}}
```
<!-- prettier-ignore-end -->

The supported attributes can be taken from the following example:

<!-- prettier-ignore-start -->
<!-- spellchecker-disable -->
{{< include file="/data/properties/demo.yaml" language="Yaml" options="linenos=table" >}}
<!-- spellchecker-enable -->
<!-- prettier-ignore-end -->

## Example

<!-- prettier-ignore-start -->
<!-- spellchecker-disable -->
{{< propertylist name=demo sort=name order=asc >}}
<!-- spellchecker-enable -->
<!-- prettier-ignore-end -->