mirror of
https://github.com/thegeeklab/hugo-geekdoc.git
synced 2024-10-30 09:50:39 +00: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.
35 lines
715 B
YAML
35 lines
715 B
YAML
---
|
|
properties:
|
|
- name: prop1
|
|
type: string
|
|
description: Dummy description of the prop1 string property.
|
|
required: true
|
|
|
|
- name: prop2
|
|
type: int
|
|
defaultValue: 10
|
|
description:
|
|
en: Another description for the integer property called prop2.
|
|
required: false
|
|
tags:
|
|
en:
|
|
- tag1
|
|
- tag2
|
|
|
|
- name: prop3
|
|
type: bool
|
|
defaultValue: false
|
|
description: |
|
|
A `bool` property with a complex multiline description and embedded Markdown:
|
|
|
|
- List item 1
|
|
- List item 2
|
|
|
|
More description how to use this property.
|
|
required: false
|
|
|
|
- name: a-prop
|
|
type: string
|
|
description: Property to demonstrate sorting.
|
|
required: true
|