Rich text formatting guide for Jira Cloud
This page explains how to format text in Jira Cloud using Power Scripts syntax. It covers basic formatting, content structure elements, tables, media embeds, detailing field compatibility, and known limitations.
Atlassian Document Format (ADF) is the underlying system that powers rich text in Jira Cloud.
Formatting behavior varies between Jira Data Center and Jira Cloud. Jira DC typically uses Wiki Markup format. Line breaks (\n
) are consistently preserved across both Jira DC and Jira Cloud.
While ADF is complex and requires detailed technical knowledge, Power Scripts offers a simplified syntax to help you format text in various Jira fields efficiently.
This simplified syntax:
Reduces the learning curve.
Minimizes formatting errors.
Maintains consistency across documentation.
Converts automatically to valid ADF format.
Fields compatibility
Some fields do not support rich text formatting due to their specific design purposes and technical limitations. Understanding field compatibility is crucial for effective content management.
Compatible fields:
Can store ADF content in the Jira database.
Include the necessary frontend components to display rich text.
Can process and validate ADF content.
The following table provides detailed information about Jira field compatibility:
Field type | Compatibility | Description |
---|---|---|
Description | Core Jira fields that are built to process and display formatted content | |
Environment | Built-in Jira field designed to store detailed environment information with rich text support | |
Comments | Native Jira elements that support rich text for better communication | |
Worklog entries |