Skip to content

Commit

Permalink
docs: add hint to config options - fields (#6779)
Browse files Browse the repository at this point in the history
  • Loading branch information
martinjagodic committed May 22, 2023
1 parent ee3a49f commit a7daa07
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions website/content/docs/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,7 @@ The `fields` option maps editor UI widgets to field-value pairs in the saved fil
* `widget`: defines editor UI and inputs and file field data types; details in [Widgets](../widgets)
* `default`: specify a default value for a field; available for most widget types (see [Widgets](../widgets) for details on each widget type). Please note that field default value only works for folder collection type.
* `required`: specify as `false` to make a field optional; defaults to `true`
* `hint`: optionally add helper text directly below a widget. Useful for including instructions. Accepts markdown for bold, italic, strikethrough, and links.
* `pattern`: add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with [custom widgets](../custom-widgets/#advanced-field-validation)

Check warning on line 353 in website/content/docs/configuration-options.md

View workflow job for this annotation

GitHub Actions / Vale

[warning] Avoid.Passive

'be achieved' is passive voice. Use active voice.
* `comment`: optional comment to add before the field (only supported for `yaml`)

Expand Down

0 comments on commit a7daa07

Please sign in to comment.