Wiki markup format is broken or not rendering as expected in Jira

Still need help?

The Atlassian Community is here for you.

Ask the community


  

Platform Notice: Cloud, Server, and Data Center - This article applies equally to all platforms.

Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.

*Except Fisheye and Crucible

  

Summary

Wiki markup is not rendering as expected in Jira. Some of them are rendering fine, while others are not being rendered or seem to be broken.

Example 1: text is not bolded, but surrounded by asterisks

Example below, the first line of Commitment Description is expected to be bold but it isn't. However, we can see that wiki markup does work for other lines in the same field. 

screenshot of jira issue view. commitment description text is not bolded but is instead surrounded by asterisks

Example 2: text is not correctly wrapped as a citation due to carriage returns

When using the citation notation (??), the cited text is only effective when there is no carriage return.  When a carriage return (line break) is part of the cited text, the citation notation (??) does not work.

Text entered with carriage return (line break):
jira comment box in text mode with carriage returns highlighted

Content rendered in visual mode:
jira comment box in visual mode with no citation notation. the double question marks are displayed instead of the proper notation formatting.

Check for extra hidden characters in your text strings

When highlighting the misbehaving string in a text editor, the character count exceeds the expected value. In this example, the string "Commitment Description" has 22 characters. A text editor shows 23.
text editor example. the text string commitment description is highlighted. this is a 22 character string, but the editor states this is 23 characters.

Querying the character length in the Jira database also yields the same results.

This 23rd character is a hidden special character within the string. Characters like these break Jira wiki markup rendering. In this example, the hidden special character is between t  and a whitespace. Highlighting this special character will show in the character count.

10 characters selected. the highlighted string is the word commitment.11 characters selected. the highlighted string is the word commitment as before, but now includes the hidden character.


Remove the hidden special character from the string or carriage return (line break) in formatted text for wiki markup to work as normal.

Last modified on Nov 21, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.