Markdown Field
What is a Markdown Field?
A Markdown Field is used when users need to enter formatted text using Markdown.
Markdown makes it easy to format content without writing HTML.
Users can create:
headings,
bold text,
italic text,
lists,
links,
and more using simple Markdown syntax.
When to use a Markdown Field?
Use a Markdown Field when users need simple formatting without using HTML.
Good examples:
Use Case | Example |
|---|---|
Notes | Workflow notes |
Description | Product description |
Formatted Message | Rich text messages |
How to configure a Markdown Field?
Step 1 - Configure the Field
Fill in the field details:
Property | Value | Example |
|---|---|---|
Type | markdown | markdown |
Label | Field name (what the users see) | Notes |
Key | API parameter name (what the API reads) | notes |
Required | Makes the field mandatory | Yes / No |
Placeholder | Example Markdown content shown inside the field |
|
Help | Text displayed on hover for user guidance | Enter the data in plain text or in Markdown format |
[
{
"key": "notes",
"type": "markdown",
"label": "Notes",
"help": "Enter the data in plain text or Markdown format",
"required": false,
"placeholder": "# Enter notes here"
}
]Additionally, attributes like defaultValue, visibilityCondition can be used as per need and requirement.
Step 2 - Save the Field
Click anywhere outside the field settings panel to automatically save the field.
