mirror of
https://github.com/thegeeklab/hugo-geekdoc.git
synced 2024-07-05 16:40:55 +02:00
Robert Kaussow
128a55e974
BREAKING CHANGE: To enable sorting of elements in the `properties` shortcode, it was necessary to change the structure of the properties file. Due to this change, the `properties` object now requires a list of maps instead of a map. A [sample file](https://raw.githubusercontent.com/thegeeklab/hugo-geekdoc/main/exampleSite/data/properties/demo.yaml) can be found in the repository.
38 lines
1.3 KiB
Markdown
38 lines
1.3 KiB
Markdown
---
|
|
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 -->
|