[TASK] Allow markdown syntax in settings descriptions (#5329)

* [TASK] Allow markdown syntax in settings descriptions

Resolves: TYPO3-Documentation/Changelog-To-Doc#1201

Releases: main, 13.4

* Update Documentation/ApiOverview/SiteHandling/SiteSettingDefinitions.rst

Co-authored-by: Stefan Frömken <[email protected]>

---------

Co-authored-by: Stefan Frömken <[email protected]>

Author: linawolf

Documentation/ApiOverview/SiteHandling/SiteSettingDefinitions.rst

@@ -79,6 +79,12 @@ Site setting definition properties
         ..  confval:: description
             :type: string
             :name: site-settings-definition-settings-description
+            :Example: 'Configure `baz` to be used in `bar`.'
+
+            While Markdown syntax can be used in YAML to provide rich text formatting, there are
+            a few gotchas. Because YAML is sensitive to special characters and indentation, you
+            might need to wrap your Markdown text in single quotes (') to prevent it from breaking
+            the YAML syntax.
 
         ..  confval:: category
             :type: :confval:`site-settings-definition-categories` key