Jira Description Markdown

.:'Jira','og:description':'Jira is a commercial error tracking system designed to organize interaction with users, although in some cases it is used to. The description should contain details of the problem and how to reproduce it, so that we can more easily track down the problem and try to fix it. After several intense years spent on Open Source projects in GitHub, I am returning to Jira (a consulting job for a customer that uses Jira. The description is not just text, but a custom markdown. And, generally, markdown allows for checkboxes - which JIRA's simply doesn't acknowledge. Understanding that, it may not be that they 'simply don't acknowledge' it, though - considering that any checkbox checked needs to be recorded and stored in the database for future reference.

Description Adding programming code in the description field in JIRA is painful. If you are adding the code inline, such as this.code(here) then you highlight it, and pick Style - Preformatted (but only when this editor is in Text mode, if you are in Visual mode then it turns the whole paragraph into preformatted text).

• Status:Applied(View Workflow)
• Resolution: Persuasive with Modification

• Specification:
• Raised in Version:
• Work Group:
• Related URL:
• Related Artifact(s):
• Grouping:
• Resolution Description:

  Hide

  Discussion seems to favor changing .description to markdown, not Annotation.

  Show

  Discussion seems to favor changing .description to markdown, not Annotation.
• Resolution Vote:
• Change Category:
• Change Impact:

Review whether the DocumentReference.description element should remain a string or be changed to Annotation.

Are there use cases where it would be beneficial for the content to be Markup? Are there use cases where it is important to know who the author of the description is?

features · Jun 3, 2015

Our Very Own Markdown

You may have heard of Markdown. If you have, it is a good thing. It can create rich texts, like in Microsoft Word, easily and quickly. For those of you who do not know what it is, here is the introduction by its creator, John Gruber (of Daring Fireball): http://daringfireball.net/projects/markdown/

So, we have Markdown. Precisely, Quire's own flavored Markdown.

Follow these 3 steps to see a few examples:

Go to any task -> Add description or comment (or click on Edit) -> Click on the '?' mark

Voila! A pop-up of our markdown list:

Want to add emphasis? You can either use * (wow!) for italic, or two asterisks (wow!) for bold.

To create a list, add an asterisk and a space before your items. It is just like what you would do if you were using Word or Page, but easier and quicker.

Wait, there's more!

Sometimes, words just are not enough. Thankfully, you can use emoji icons in the description and comment of a task. If you type a colon, a list of emoji will automatically show up:

Talk about being 'expressive'!

Next is something you will definitely find useful.

When you want to refer someone to a particular task, just enter @username and then #taskname. All the tasks containing the letters you have typed will show up. Simply find the right one.

This way, there is no more copying and posting the URL of a task.

Now that you have seen what our Markdown can do, see the cheat sheet below and give it a go!

HEADERS

Quire's Markdown supports two styles of headers, Setext and Atx.

Setext-style headers use equal signs (for first-level headers) and dashes (for second-level headers). For example:

Atx-style headers use 1–6 number signs at the start of the line, followed by 1–6 header levels. For example:

LINE BREAKS

To generate a new line, you press ENTER.

Apple music recognition. HORIZONTAL RULES

For the latest information on how Coronavirus (Covid-19) may be affecting our Sky services, go here. Remember, you can do most things online at Sky.com. You'll find handy guides that deal with all kinds of issues and queries below. Over 90% of our customers who use our online guides get the help they need before even having to get in touch. Find out how many devices you can register on Sky Go, and how to view or remove registered devices. Find help for all Sky's services including TV, Broadband, Talk, Sky Mobile, Sky Yahoo Mail and Sky Go. Sky go supported devices. Help with the new Sky Go app, including how to set up Sky Go, watch Sky Go, fix a problem or manage devices and settings. Sky Go opens up awesome new ways to watch TV and it's loaded with powerful features that are really easy to use. If you're running late, stuck at work or just want a break from the couch, you won't need to miss seeing any of the action live, because Sky Go lets you keep on watching.

You can produce a horizontal rule by typing 3 or more hyphens, asterisks or underscores, with space in between if you like:

EMPHASIS

You use asterisks to indicate emphasis.

For italic, you use 1 asterisk. For example:

For bold, you use 2 asterisks. For example:

UNDERLINES

You can use one underscore at the start and the end of the text:

STRIKETHROUGHS

You can use one tilde at the start and the end of the text:

LISTS

Markdown supports ordered (numbered) and unordered (bulleted) lists.

Order list uses numbers and periods like:

Unordered list like:

is the same as:

and:

Each item may consist of multiple paragraphs. To add a paragraph in a list item, indent 4 spaces or 1 tab like this:

LINKS

You use square brackets to delimit the text and round brackets for the link. For example,

Markdown also supports 3 variants of links. First is a title for your link:

Second is the reference-style link that uses second set of square brackets that contain an id you choose for the link:

Then, anywhere in the text, you define your link id:

The third is an automated Link. You can simply write down a link, Markdown will turn it into a clickable link:

IMAGES

Markdown supports two styles of images: inline and reference.

Inline image syntax looks like this:

You write down an exclamation mark, a set of square brackets containing an alt attribute text for the image, a second set of square brackets containing the URL or path to the image, and an optional title attribute enclosed in double quotes.

Reference image syntax looks like this:

In this style of writing, 'id' is the name of a defined image reference, which is defined in the same way as link references.

TABLES

You can create tables using | (pipes) and - (hyphens).

Pipes are used to separate each column and hyphens create each column's header.

So, if you type:

It will turn out like this:

Tip: You can type
to break a line in a table cell, and
to keep
in the cell.

ESCAPE PIPE

You may want to escape a pipe in a table cell. It can be done easily with in front of the pipe.

For example, if you type:

It will look like this:

BLOCKQUOTES

Blockquotes are indicated using '>' angle brackets.

Also, blockquotes can rest in blockquotes by adding levels of angle brackets:

CHECKLISTS

You can create your own checklist by typing - [ ]

With Quire checklist, you can tick off your checklist as well.

PHONE NUMBERS

You can type in the phone numbers in one of the above format and the system will generate a hyperlink to make a call.

CODE

To indicate a span of code, wrap it with '`' backtick quotes. For example,

To include backtick characters in a code, you use multiple backtick quotes and spaces — one after the opening and one before the closing — like this:

CODE BLOCK

Avogadros number is. You can generate a code block by indenting 4 spaces or 1 tab:

Or type 3 backticks in the beginning and the end of the text like this:

Remember to break the line before and after the backticks.

SYNTAX HIGHLIGHTING

We take code block one step further by adding Syntax Highlighting.

For example, if you define CSS as your content language:

Or if you choose Javascript as your content language:

You will see that it displays text in different colors according to the content language you chose, making it easier for programmers and developers to read.

CSS Styles

Second is the reference-style link that uses second set of square brackets that contain an id you choose for the link:

Then, anywhere in the text, you define your link id:

The third is an automated Link. You can simply write down a link, Markdown will turn it into a clickable link:

IMAGES

Markdown supports two styles of images: inline and reference.

Inline image syntax looks like this:

You write down an exclamation mark, a set of square brackets containing an alt attribute text for the image, a second set of square brackets containing the URL or path to the image, and an optional title attribute enclosed in double quotes.

Reference image syntax looks like this:

In this style of writing, 'id' is the name of a defined image reference, which is defined in the same way as link references.

TABLES

You can create tables using | (pipes) and - (hyphens).

Pipes are used to separate each column and hyphens create each column's header.

So, if you type:

It will turn out like this:

Tip: You can type
to break a line in a table cell, and
to keep
in the cell.

ESCAPE PIPE

You may want to escape a pipe in a table cell. It can be done easily with in front of the pipe.

For example, if you type:

It will look like this:

BLOCKQUOTES

Blockquotes are indicated using '>' angle brackets.

Also, blockquotes can rest in blockquotes by adding levels of angle brackets:

CHECKLISTS

You can create your own checklist by typing - [ ]

With Quire checklist, you can tick off your checklist as well.

PHONE NUMBERS

You can type in the phone numbers in one of the above format and the system will generate a hyperlink to make a call.

CODE

To indicate a span of code, wrap it with '`' backtick quotes. For example,

To include backtick characters in a code, you use multiple backtick quotes and spaces — one after the opening and one before the closing — like this:

CODE BLOCK

Avogadros number is. You can generate a code block by indenting 4 spaces or 1 tab:

Or type 3 backticks in the beginning and the end of the text like this:

Remember to break the line before and after the backticks.

SYNTAX HIGHLIGHTING

We take code block one step further by adding Syntax Highlighting.

For example, if you define CSS as your content language:

Or if you choose Javascript as your content language:

You will see that it displays text in different colors according to the content language you chose, making it easier for programmers and developers to read.

CSS Styles

You can add CSS style to text in task name, description and comment with {css-style| text}.

For instance, if you type:

It will turn out like this:

Characters

You can now add characters too via HTML entities.

Let's say you type:

It will turn out like this:

¥, ®, ℃ and ☻

BACKSLASH ESCAPES

We let you use (backslash) to surround text with characters, so you can escape the characters' general meaning.

For example, if you want to surround a word with asterisks, use backslashes before the asterisks:

Jira Description Markdown Example

Then, it will turn out like this:

We support backslash escapes for the following characters:

• backslash
• ` backtick
• * asterisk
• _ underscore
• {} curly braces
• [] square brackets
• () parentheses
• # hash mark
• + plus sign
• - hyphen
• . dot
• ! exclamation mark

Use Markdown In Jira

YOUTUBE VIDEOS

Youtube videos can be added if you add an image with a link to the video:

Please stay tuned for more to come!