Card description. Text formatting in a card

Card description is the text that explains the task.

The description allows you to format the text, add images, files, tables, etc.

In this article you will learn:

  • How to add a card description;

  • How to format text in the card;

  • How to add a diagram to the description using PlantUML;

  • How to edit text in a card using Markdown.

Adding description

Open a card, click in the field under Description and enter the required information. Click the saving button to save your changes.

Text formatting

Format text, add pictures, tables, code blocks, lists and separators through the editor interface.

Click on the field under the "Description" heading, then click on the plus sign.

A text editing toolbar will appear in front of you. Select the desired element and add it to the text.

If the text is already written in the field, you can also edit it by selecting the desired part.

In addition to Card Description, the text editor is available in:

  • Comments

  • Blockings

  • Checklist items

  • String custom fields

  • Story map card descriptions

  • Board descriptions

  • Template card descriptions

Drawing Diagrams in Descriptions with PlantUML

You can draw diagrams in a card description using PlantUML.

This will help you better communicate your task to the implementer and avoid mistakes. For example, clearly explain to the developer what should happen at a particular user action.

Please note, that PlantUML is a third-party product and we do not support it and are not responsible for its performance.

Markdown text formatting

If you are more used to format text via Markdown then click the three dots in the text editing window.

This will bring up the window where you can format text using Markdown.

Markdown editing is also available in Comments, Blockings, Checklists, Custom String fields, Story map card descriptions, Board descriptions.

A handy tutorial on Markdown can be found here.