decaporg / decaporg/decap-cms

Allow markdown in field hints

Open
#3,759 3 comments 7 reactions 0 assignees View on GitHub
area: extensions/widgets/markdown area: ux type: feature
Dominant language
JavaScript
Stars
19.4k
Forks
3.1k
Avg merge
1d 14h
Merged PRs (30d)
9

Description

Would it be possible for the `hint` parameter to be able to render markdown text?

As an editor, the text below each field is a very valuable place for including helpful reminders, style examples, links to the style guide, etc... Having the ability to make certain words bold, italic, add links is super helpful, if not essential.

**Here is an example of the summary field:**
```
- label: "Summary"
name: "summary"
minimal: true
widget: "string"
default: ""
hint: "One-sentence description of the event. _(e.g. Artist [Name] with writer [Name], discuss creative life in the context of our new social reality.)_"
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.