hugo-geekdoc/exampleSite/data/properties/demo.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
feat: add propertylist shortcode (#414) 2022-05-22 20:00:37 +00:00			`---`
			`properties:`
feat: add option to sort items in properties shortcode (#527) 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. 2022-11-02 12:01:20 +00:00			`- name: prop1`
feat: add propertylist shortcode (#414) 2022-05-22 20:00:37 +00:00			`type: string`
			`description: Dummy description of the prop1 string property.`
			`required: true`

feat: add option to sort items in properties shortcode (#527) 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. 2022-11-02 12:01:20 +00:00			`- name: prop2`
feat: add propertylist shortcode (#414) 2022-05-22 20:00:37 +00:00			`type: int`
			`defaultValue: 10`
			`description:`
			`en: Another description for the integer property called prop2.`
			`required: false`
			`tags:`
			`en:`
			`- tag1`
			`- tag2`
feat: render popertylist description as markdown (#426) 2022-05-30 19:40:09 +00:00
feat: add option to sort items in properties shortcode (#527) 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. 2022-11-02 12:01:20 +00:00			`- name: prop3`
feat: render popertylist description as markdown (#426) 2022-05-30 19:40:09 +00:00			`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`
feat: add option to sort items in properties shortcode (#527) 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. 2022-11-02 12:01:20 +00:00
			`- name: a-prop`
			`type: string`
			`description: Property to demonstrate sorting.`
			`required: true`